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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  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>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  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>\r
  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>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 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>\r
 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.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20090501000200 -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 133 </div>
 134 <div  class="sponsor">
 135    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <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>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 157 _8c.html" target="source" name="ConstituteImage">ConstituteImage</a></h2>
 158 <div class="doc-section">
 159
 160 <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>
 161
 162 <pre class="text">
 163   image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
 164 </pre>
 165
 166 <p>The format of the ConstituteImage method is:</p>
 167
 168 <pre class="code">
 169   Image *ConstituteImage(const unsigned long columns,
 170     const unsigned long rows,const char *map,const StorageType storage,
 171     const void *pixels,ExceptionInfo *exception)
 172 </pre>
 173
 174 <p>A description of each parameter follows:</p></ol>
 175
 176 <h5>columns</h5>
 177 <ol><p>width in pixels of the image.</p></ol>
 178
 179 <h5>rows</h5>
 180 <ol><p>height in pixels of the image.</p></ol>
 181
 182 <h5>map</h5>
 183 <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>
 184
 185 <h5>storage</h5>
 186 <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>
 187
 188 <h5>pixels</h5>
 189 <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>
 190
 191 <h5>exception</h5>
 192 <ol><p>return any errors or warnings in this structure.</p></ol>
 193
 194  </div>
 195 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 196 _8c.html" target="source" name="PingImage">PingImage</a></h2>
 197 <div class="doc-section">
 198
 199 <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>
 200
 201 <p>The format of the PingImage method is:</p>
 202
 203 <pre class="code">
 204   Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
 205 </pre>
 206
 207 <p>A description of each parameter follows:</p></ol>
 208
 209 <h5>image_info</h5>
 210 <ol><p>Ping the image defined by the file or filename members of this structure.</p></ol>
 211
 212 <h5>exception</h5>
 213 <ol><p>return any errors or warnings in this structure.</p></ol>
 214
 215  </div>
 216 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 217 _8c.html" target="source" name="PingImages">PingImages</a></h2>
 218 <div class="doc-section">
 219
 220 <p>PingImages() pings one or more images and returns them as an image list.</p></ol>
 221
 222 <p>The format of the PingImage method is:</p>
 223
 224 <pre class="code">
 225   Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception)
 226 </pre>
 227
 228 <p>A description of each parameter follows:</p></ol>
 229
 230 <h5>image_info</h5>
 231 <ol><p>the image info.</p></ol>
 232
 233 <h5>exception</h5>
 234 <ol><p>return any errors or warnings in this structure.</p></ol>
 235
 236  </div>
 237 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 238 _8c.html" target="source" name="ReadImage">ReadImage</a></h2>
 239 <div class="doc-section">
 240
 241 <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>
 242
 243 <p>The format of the ReadImage method is:</p>
 244
 245 <pre class="code">
 246   Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
 247 </pre>
 248
 249 <p>A description of each parameter follows:</p></ol>
 250
 251 <h5>image_info</h5>
 252 <ol><p>Read the image defined by the file or filename members of this structure.</p></ol>
 253
 254 <h5>exception</h5>
 255 <ol><p>return any errors or warnings in this structure.</p></ol>
 256
 257  </div>
 258 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 259 _8c.html" target="source" name="ReadImages">ReadImages</a></h2>
 260 <div class="doc-section">
 261
 262 <p>ReadImages() reads one or more images and returns them as an image list.</p></ol>
 263
 264 <p>The format of the ReadImage method is:</p>
 265
 266 <pre class="code">
 267   Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
 268 </pre>
 269
 270 <p>A description of each parameter follows:</p></ol>
 271
 272 <h5>image_info</h5>
 273 <ol><p>the image info.</p></ol>
 274
 275 <h5>exception</h5>
 276 <ol><p>return any errors or warnings in this structure.</p></ol>
 277
 278  </div>
 279 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 280 _8c.html" target="source" name="WriteImage">WriteImage</a></h2>
 281 <div class="doc-section">
 282
 283 <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>
 284
 285 <p>The format of the WriteImage method is:</p>
 286
 287 <pre class="code">
 288   MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
 289 </pre>
 290
 291 <p>A description of each parameter follows:</p></ol>
 292
 293 <h5>image_info</h5>
 294 <ol><p>the image info.</p></ol>
 295
 296 <h5>image</h5>
 297 <ol><p>the image.</p></ol>
 298
 299  </div>
 300 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 301 _8c.html" target="source" name="WriteImages">WriteImages</a></h2>
 302 <div class="doc-section">
 303
 304 <p>WriteImages() writes an image sequence.</p></ol>
 305
 306 <p>The format of the WriteImages method is:</p>
 307
 308 <pre class="code">
 309   MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
 310     const char *filename,ExceptionInfo *exception)
 311 </pre>
 312
 313 <p>A description of each parameter follows:</p></ol>
 314
 315 <h5>image_info</h5>
 316 <ol><p>the image info.</p></ol>
 317
 318 <h5>images</h5>
 319 <ol><p>the image list.</p></ol>
 320
 321 <h5>filename</h5>
 322 <ol><p>the image filename.</p></ol>
 323
 324 <h5>exception</h5>
 325 <ol><p>return any errors or warnings in this structure.</p></ol>
 326
 327  </div>
 328 \r
 329 </div>\r
 330 \r
 331 <div id="linkbar">\r
 332  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 333     <span id="linkbar-center">\r
 334       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 335       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 336     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 337     </span>\r
 338     <span id="linkbar-east">&nbsp;</span>\r
 339   </div>\r
 340   <div class="footer">\r
 341     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 342     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 343   </div>\r
 344   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 345 </body>\r
 346 </html>\r