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 http-equiv="Content-Type" value="application/xhtml+xml" />\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   7   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   8   <style type="text/css" media="screen,projection"><!--\r
   9     @import url("../../www/magick.css");\r
  10   --></style>\r
  11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  12   <title>ImageMagick: MagickCore, C API for ImageMagick: Constitute an Image</title>
  13   <meta http-equiv="Content-Language" content="en-US"/>
  14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="Generator" content="PHP"/>
  17   <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"/>
  18   <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."/>
  19   <meta name="Rating" content="GENERAL"/>
  20   <meta name="Robots" content="INDEX, FOLLOW"/>
  21   <meta name="Generator" content="ImageMagick Studio LLC"/>
  22   <meta name="Author" content="ImageMagick Studio LLC"/>
  23   <meta name="Revisit-after" content="2 DAYS"/>
  24   <meta name="Resource-type" content="document"/>
  25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  26   <meta name="Distribution" content="Global"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../../index.html">\r
  32   <img src="../../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../../index.html">\r
  41   <img src="../../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="eastbar">\r
  46 \r
  47 <div class="menu">
  48   <a href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
 128 </div>
 129 <div  class="sponsor">
 130   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 134 </div>
 135 <div  class="sponsor">
 136   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 137 </div>
 138 <div  class="sponsor">
 139   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 143 </div>
 144 <div  class="sponsor">
 145    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 146 </div>
 147 <div  class="sponsor">
 148   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 149 </div>
 150 </div>
 151 </div>
 152 \r
 153 \r
 154 </div>\r
 155 \r
 156 <div class="main">\r
 157 \r
 158 <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>
 159
 160 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 161 _8c.html" target="source" name="ConstituteImage">ConstituteImage</a></h2>
 162 <div class="doc-section">
 163
 164 <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>
 165
 166 <pre class="text">
 167   image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
 168 </pre>
 169
 170 <p>The format of the ConstituteImage method is:</p>
 171
 172 <pre class="code">
 173   Image *ConstituteImage(const unsigned long columns,
 174     const unsigned long rows,const char *map,const StorageType storage,
 175     const void *pixels,ExceptionInfo *exception)
 176 </pre>
 177
 178 <p>A description of each parameter follows:</p></ol>
 179
 180 <h5>columns</h5>
 181 <ol><p>width in pixels of the image.</p></ol>
 182
 183 <h5>rows</h5>
 184 <ol><p>height in pixels of the image.</p></ol>
 185
 186 <h5>map</h5>
 187 <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>
 188
 189 <h5>storage</h5>
 190 <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>
 191
 192 <h5>pixels</h5>
 193 <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>
 194
 195 <h5>exception</h5>
 196 <ol><p>return any errors or warnings in this structure.</p></ol>
 197
 198  </div>
 199 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 200 _8c.html" target="source" name="PingImage">PingImage</a></h2>
 201 <div class="doc-section">
 202
 203 <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>
 204
 205 <p>The format of the PingImage method is:</p>
 206
 207 <pre class="code">
 208   Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
 209 </pre>
 210
 211 <p>A description of each parameter follows:</p></ol>
 212
 213 <h5>image_info</h5>
 214 <ol><p>Ping the image defined by the file or filename members of this structure.</p></ol>
 215
 216 <h5>exception</h5>
 217 <ol><p>return any errors or warnings in this structure.</p></ol>
 218
 219  </div>
 220 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 221 _8c.html" target="source" name="PingImages">PingImages</a></h2>
 222 <div class="doc-section">
 223
 224 <p>PingImages() pings one or more images and returns them as an image list.</p></ol>
 225
 226 <p>The format of the PingImage method is:</p>
 227
 228 <pre class="code">
 229   Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception)
 230 </pre>
 231
 232 <p>A description of each parameter follows:</p></ol>
 233
 234 <h5>image_info</h5>
 235 <ol><p>the image info.</p></ol>
 236
 237 <h5>exception</h5>
 238 <ol><p>return any errors or warnings in this structure.</p></ol>
 239
 240  </div>
 241 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 242 _8c.html" target="source" name="ReadImage">ReadImage</a></h2>
 243 <div class="doc-section">
 244
 245 <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>
 246
 247 <p>The format of the ReadImage method is:</p>
 248
 249 <pre class="code">
 250   Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
 251 </pre>
 252
 253 <p>A description of each parameter follows:</p></ol>
 254
 255 <h5>image_info</h5>
 256 <ol><p>Read the image defined by the file or filename members of this structure.</p></ol>
 257
 258 <h5>exception</h5>
 259 <ol><p>return any errors or warnings in this structure.</p></ol>
 260
 261  </div>
 262 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 263 _8c.html" target="source" name="ReadImages">ReadImages</a></h2>
 264 <div class="doc-section">
 265
 266 <p>ReadImages() reads one or more images and returns them as an image list.</p></ol>
 267
 268 <p>The format of the ReadImage method is:</p>
 269
 270 <pre class="code">
 271   Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
 272 </pre>
 273
 274 <p>A description of each parameter follows:</p></ol>
 275
 276 <h5>image_info</h5>
 277 <ol><p>the image info.</p></ol>
 278
 279 <h5>exception</h5>
 280 <ol><p>return any errors or warnings in this structure.</p></ol>
 281
 282  </div>
 283 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 284 _8c.html" target="source" name="WriteImage">WriteImage</a></h2>
 285 <div class="doc-section">
 286
 287 <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>
 288
 289 <p>The format of the WriteImage method is:</p>
 290
 291 <pre class="code">
 292   MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
 293 </pre>
 294
 295 <p>A description of each parameter follows:</p></ol>
 296
 297 <h5>image_info</h5>
 298 <ol><p>the image info.</p></ol>
 299
 300 <h5>image</h5>
 301 <ol><p>the image.</p></ol>
 302
 303  </div>
 304 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 305 _8c.html" target="source" name="WriteImages">WriteImages</a></h2>
 306 <div class="doc-section">
 307
 308 <p>WriteImages() writes an image sequence.</p></ol>
 309
 310 <p>The format of the WriteImages method is:</p>
 311
 312 <pre class="code">
 313   MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
 314     const char *filename,ExceptionInfo *exception)
 315 </pre>
 316
 317 <p>A description of each parameter follows:</p></ol>
 318
 319 <h5>image_info</h5>
 320 <ol><p>the image info.</p></ol>
 321
 322 <h5>images</h5>
 323 <ol><p>the image list.</p></ol>
 324
 325 <h5>filename</h5>
 326 <ol><p>the image filename.</p></ol>
 327
 328 <h5>exception</h5>
 329 <ol><p>return any errors or warnings in this structure.</p></ol>
 330
 331  </div>
 332 \r
 333 </div>\r
 334 \r
 335 <div id="linkbar">\r
 336  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 337     <span id="linkbar-center">\r
 338       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 339     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 340     </span>\r
 341     <span id="linkbar-east">&nbsp;</span>\r
 342   </div>\r
 343   <div class="footer">\r
 344     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 345     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 346   </div>\r
 347   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 348 </body>\r
 349 </html>\r