granicus.if.org Git - imagemagick/blob - www/api/constitute.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   4 <head>
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
   7   <style type="text/css" media="screen,projection"><!--
   8     @import url("../../www/magick.css");
   9   --></style>
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Constitute an Image</title>
  12   <meta http-equiv="Content-Language" content="en-US"/>
  13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  15   <meta name="Generator" content="PHP"/>
  16   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, constitute, an, image, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  17   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>
  27
  28 <body id="www-imagemagick-org">
  29 <div class="titlebar">
  30 <a href="../../index.html">
  31   <img src="../../images/script.png" alt="[ImageMagick]"
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
  33 <a href="http://www.networkredux.com">
  34   <img src="../../images/networkredux.png" alt="[sponsor]"
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>
  36 <a href="http://www.imagemagick.org/discourse-server/">
  37   <img src="../../images/logo.jpg" alt=""
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  39 <a href="../../index.html">
  40   <img src="../../images/sprite.jpg" alt=""
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  42 </div>
  43
  44 <div class="eastbar">
  45
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
 139 </div>
 140 </div>
 141 </div>
 142
 143
 144 </div>
 145
 146 <div class="main">
 147
 148 <p class="navigation-index">[<a href="#ConstituteImage">ConstituteImage</a> &bull; <a href="#PingImage">PingImage</a> &bull; <a href="#PingImages">PingImages</a> &bull; <a href="#ReadImage">ReadImage</a> &bull; <a href="#ReadImages">ReadImages</a> &bull; <a href="#WriteImage">WriteImage</a> &bull; <a href="#WriteImages">WriteImages</a>]</p>
 149
 150 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 151 _8c.html" target="source" name="ConstituteImage">ConstituteImage</a></h2>
 152 <div class="doc-section">
 153
 154 <p>ConstituteImage() returns an image from the pixel data you supply. The pixel data must be in scanline order top-to-bottom.  The data can be char, short int, int, float, or double.  Float and double require the pixels to be normalized [0..1], otherwise [0..QuantumRange].  For example, to create a 640x480 image from unsigned red-green-blue character data, use:</p>
 155
 156 <pre class="text">
 157   image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
 158 </pre>
 159
 160 <p>The format of the ConstituteImage method is:</p>
 161
 162 <pre class="code">
 163   Image *ConstituteImage(const unsigned long columns,
 164     const unsigned long rows,const char *map,const StorageType storage,
 165     const void *pixels,ExceptionInfo *exception)
 166 </pre>
 167
 168 <p>A description of each parameter follows:</p></ol>
 169
 170 <h5>columns</h5>
 171 <ol><p>width in pixels of the image.</p></ol>
 172
 173 <h5>rows</h5>
 174 <ol><p>height in pixels of the image.</p></ol>
 175
 176 <h5>map</h5>
 177 <ol><p>This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.</p></ol>
 178
 179 <h5>storage</h5>
 180 <ol><p>Define the data type of the pixels.  Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange].  Choose from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel, LongPixel, QuantumPixel, or ShortPixel.</p></ol>
 181
 182 <h5>pixels</h5>
 183 <ol><p>This array of values contain the pixel components as defined by map and type.  You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.</p></ol>
 184
 185 <h5>exception</h5>
 186 <ol><p>return any errors or warnings in this structure.</p></ol>
 187
 188  </div>
 189 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 190 _8c.html" target="source" name="PingImage">PingImage</a></h2>
 191 <div class="doc-section">
 192
 193 <p>PingImage() returns all the properties of an image or image sequence except for the pixels.  It is much faster and consumes far less memory than ReadImage().  On failure, a NULL image is returned and exception describes the reason for the failure.</p></ol>
 194
 195 <p>The format of the PingImage method is:</p>
 196
 197 <pre class="code">
 198   Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
 199 </pre>
 200
 201 <p>A description of each parameter follows:</p></ol>
 202
 203 <h5>image_info</h5>
 204 <ol><p>Ping the image defined by the file or filename members of this structure.</p></ol>
 205
 206 <h5>exception</h5>
 207 <ol><p>return any errors or warnings in this structure.</p></ol>
 208
 209  </div>
 210 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 211 _8c.html" target="source" name="PingImages">PingImages</a></h2>
 212 <div class="doc-section">
 213
 214 <p>PingImages() pings one or more images and returns them as an image list.</p></ol>
 215
 216 <p>The format of the PingImage method is:</p>
 217
 218 <pre class="code">
 219   Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception)
 220 </pre>
 221
 222 <p>A description of each parameter follows:</p></ol>
 223
 224 <h5>image_info</h5>
 225 <ol><p>the image info.</p></ol>
 226
 227 <h5>exception</h5>
 228 <ol><p>return any errors or warnings in this structure.</p></ol>
 229
 230  </div>
 231 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 232 _8c.html" target="source" name="ReadImage">ReadImage</a></h2>
 233 <div class="doc-section">
 234
 235 <p>ReadImage() reads an image or image sequence from a file or file handle. The method returns a NULL if there is a memory shortage or if the image cannot be read.  On failure, a NULL image is returned and exception describes the reason for the failure.</p></ol>
 236
 237 <p>The format of the ReadImage method is:</p>
 238
 239 <pre class="code">
 240   Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
 241 </pre>
 242
 243 <p>A description of each parameter follows:</p></ol>
 244
 245 <h5>image_info</h5>
 246 <ol><p>Read the image defined by the file or filename members of this structure.</p></ol>
 247
 248 <h5>exception</h5>
 249 <ol><p>return any errors or warnings in this structure.</p></ol>
 250
 251  </div>
 252 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 253 _8c.html" target="source" name="ReadImages">ReadImages</a></h2>
 254 <div class="doc-section">
 255
 256 <p>ReadImages() reads one or more images and returns them as an image list.</p></ol>
 257
 258 <p>The format of the ReadImage method is:</p>
 259
 260 <pre class="code">
 261   Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
 262 </pre>
 263
 264 <p>A description of each parameter follows:</p></ol>
 265
 266 <h5>image_info</h5>
 267 <ol><p>the image info.</p></ol>
 268
 269 <h5>exception</h5>
 270 <ol><p>return any errors or warnings in this structure.</p></ol>
 271
 272  </div>
 273 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 274 _8c.html" target="source" name="WriteImage">WriteImage</a></h2>
 275 <div class="doc-section">
 276
 277 <p>WriteImage() writes an image or an image sequence to a file or filehandle. If writing to a file on disk, the name is defined by the filename member of the image structure.  Write() returns MagickFalse is these is a memory shortage or if the image cannot be written.  Check the exception member of image to determine the cause for any failure.</p></ol>
 278
 279 <p>The format of the WriteImage method is:</p>
 280
 281 <pre class="code">
 282   MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
 283 </pre>
 284
 285 <p>A description of each parameter follows:</p></ol>
 286
 287 <h5>image_info</h5>
 288 <ol><p>the image info.</p></ol>
 289
 290 <h5>image</h5>
 291 <ol><p>the image.</p></ol>
 292
 293  </div>
 294 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 295 _8c.html" target="source" name="WriteImages">WriteImages</a></h2>
 296 <div class="doc-section">
 297
 298 <p>WriteImages() writes an image sequence.</p></ol>
 299
 300 <p>The format of the WriteImages method is:</p>
 301
 302 <pre class="code">
 303   MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
 304     const char *filename,ExceptionInfo *exception)
 305 </pre>
 306
 307 <p>A description of each parameter follows:</p></ol>
 308
 309 <h5>image_info</h5>
 310 <ol><p>the image info.</p></ol>
 311
 312 <h5>images</h5>
 313 <ol><p>the image list.</p></ol>
 314
 315 <h5>filename</h5>
 316 <ol><p>the image filename.</p></ol>
 317
 318 <h5>exception</h5>
 319 <ol><p>return any errors or warnings in this structure.</p></ol>
 320
 321  </div>
 322
 323 </div>
 324
 325 <div id="linkbar">
 326  <!--    <span id="linkbar-west">&nbsp;</span>  -->
 327     <span id="linkbar-center">
 328       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
 329       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
 330     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
 331     </span>
 332     <span id="linkbar-east">&nbsp;</span>
 333   </div>
 334   <div class="footer">
 335     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
 336     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
 337   </div>
 338   <div style="clear: both; margin: 0; width: 100%; "></div>
 339 </body>
 340 </html>