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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html version="-//W3C//DTD XHTML 1.1//EN"\r
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
   8 <head>\r
   9   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
  10   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
  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="Application-name" content="ImageMagick"/>
  16   <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images automagically."/>
  17   <meta name="Application-url" content="http://www.imagemagick.org"/>
  18   <meta name="Generator" content="PHP"/>
  19   <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, Image, Processing, Automagically"/>
  20   <meta name="Rating" content="GENERAL"/>
  21   <meta name="Robots" content="INDEX, FOLLOW"/>
  22   <meta name="Generator" content="ImageMagick Studio LLC"/>
  23   <meta name="Author" content="ImageMagick Studio LLC"/>
  24   <meta name="Revisit-after" content="2 DAYS"/>
  25   <meta name="Resource-type" content="document"/>
  26   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  27   <meta name="Distribution" content="Global"/>
  28   <link rel="icon" href="../../images/wand.png"/>
  29   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  30   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  31   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  32   <style type="text/css" media="all">\r
  33     @import url("../../www/magick.css");\r
  34   </style>\r
  35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  36   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  37   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  38   <script type="text/javascript">\r
  39     $(document).ready(function() {\r
  40       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  41         'transitionIn'  : 'elastic',\r
  42         'transitionOut' : 'elastic',\r
  43         'overlayShow'   : false,\r
  44         'opacity'       : true\r
  45       });\r
  46     });\r
  47   </script>\r
  48 </head>\r
  49 \r
  50 <body id="www-imagemagick-org">\r
  51 <div class="titlebar">\r
  52 <div style="margin: 17px auto; float: left;">\r
  53   <script type="text/javascript">\r
  54   <!--\r
  55     google_ad_client = "pub-3129977114552745";\r
  56     google_ad_slot = "5439289906";\r
  57     google_ad_width = 728;\r
  58     google_ad_height = 90;\r
  59   //-->\r
  60   </script>\r
  61   <script type="text/javascript"\r
  62     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
  63   </script>\r
  64 </div>\r
  65 <a href="http://www.imagemagick.org/discourse-server/">\r
  66   <img src="../../images/logo.jpg"\r
  67   alt="ImageMagick Logo"\r
  68   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  69 <a href="../../index.html">\r
  70   <img src="../../images/sprite.jpg"\r
  71   alt="ImageMagick Sprite"\r
  72   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  73 </div>\r
  74 \r
  75 <div class="westbar">\r
  76 \r
  77 <div class="menu">
  78   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div class="menu">
  82   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  83 </div>
  84 <div class="sub">
  85     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  89 </div>
  90 <div class="sub">
  91     <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
  92 </div>
  93 <div class="sub">
  94     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  95 </div>
  96 <div class="sep"></div>\r
  97 <div class="menu">
  98   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
 105 </div>
 106 <div class="sub">
 107     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 108 </div>
 109 <div class="menu">
 110   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 111 </div>
 112 <div class="sub">
 113     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 114 </div>
 115 <div class="sub">
 116     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 117 </div>
 118 <div class="sub">
 119     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 120 </div>
 121 <div class="sub">
 122     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 133  </div>
 134 <div class="menu">
 135   <a title="Resources" href="../../www/resources.html">Resources</a>
 136 </div>
 137 <div class="menu">
 138   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 139 </div>
 140 <div class="menu">
 141   <a title="Download" href="../../www/download.html">Download</a>
 142 </div>
 143 <div class="sep"></div>\r
 144 <div class="menu">
 145   <a title="Search" href="../../www/search.html">Search</a>
 146 </div>
 147 <div class="sep"></div>\r
 148 <div class="menu">
 149   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 150 </div>
 151 <div  class="sub">
 152   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 153 </div>
 154 <div class="sep"></div>\r
 155 <div  class="menu">
 156   <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 157
 158 <a href="http://www.networkredux.com">
 159   <img src="../../images/networkredux.png" alt="[sponsor]"
 160   style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 161 <div class="sponsbox">
 162 <div  class="sponsor">
 163   <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
 164 </div>
 165 <div  class="sponsor">
 166   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
 167 </div>
 168 <div  class="sponsor">
 169   <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 170 </div>
 171 <div  class="sponsor">
 172   <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
 173 </div>
 174 <div  class="sponsor">
 175   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 176 </div>
 177 <div  class="sponsor">
 178   <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
 179 </div>
 180 <div  class="sponsor">
 181   <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 182 </div>
 183 <div  class="sponsor">
 184   <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 185 </div>
 186 <div  class="sponsor">
 187   <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 188 </div>
 189 <div  class="sponsor">
 190   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
 191 </div>
 192 <div  class="sponsor">
 193   <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 194 </div>
 195 <div  class="sponsor">
 196    <a rel="follow" title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011090100025 atlas.multimedia-->
 197 </div>
 198 </div>
 199 </div>
 200 </div>\r
 201 \r
 202 <div class="eastbar">\r
 203 \r
 204 </div>\r
 205 \r
 206 <div class="main">\r
 207 \r
 208 <h1>Module constitute Methods</h1>
 209 <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>
 210
 211 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="ConstituteImage">ConstituteImage</a></h2>
 212 <div class="doc-section">
 213
 214 <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>
 215
 216 <pre class="text">
 217   image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
 218 </pre>
 219
 220 <p>The format of the ConstituteImage method is:</p>
 221
 222 <pre class="code">
 223   Image *ConstituteImage(const size_t columns,const size_t rows,
 224     const char *map,const StorageType storage,const void *pixels,
 225     ExceptionInfo *exception)
 226 </pre>
 227
 228 <p>A description of each parameter follows:</p>
 229
 230 <h5>columns</h5>
 231 <p>width in pixels of the image.</p>
 232
 233 <h5>rows</h5>
 234 <p>height in pixels of the image.</p>
 235
 236 <h5>map</h5>
 237 <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>
 238
 239 <h5>storage</h5>
 240 <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>
 241
 242 <h5>pixels</h5>
 243 <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>
 244
 245 <h5>exception</h5>
 246 <p>return any errors or warnings in this structure.</p>
 247
 248  </div>
 249 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="PingImage">PingImage</a></h2>
 250 <div class="doc-section">
 251
 252 <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>
 253
 254 <p>The format of the PingImage method is:</p>
 255
 256 <pre class="code">
 257   Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
 258 </pre>
 259
 260 <p>A description of each parameter follows:</p>
 261
 262 <h5>image_info</h5>
 263 <p>Ping the image defined by the file or filename members of this structure.</p>
 264
 265 <h5>exception</h5>
 266 <p>return any errors or warnings in this structure.</p>
 267
 268  </div>
 269 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="PingImages">PingImages</a></h2>
 270 <div class="doc-section">
 271
 272 <p>PingImages() pings one or more images and returns them as an image list.</p>
 273
 274 <p>The format of the PingImage method is:</p>
 275
 276 <pre class="code">
 277   Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception)
 278 </pre>
 279
 280 <p>A description of each parameter follows:</p>
 281
 282 <h5>image_info</h5>
 283 <p>the image info.</p>
 284
 285 <h5>exception</h5>
 286 <p>return any errors or warnings in this structure.</p>
 287
 288  </div>
 289 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="ReadImage">ReadImage</a></h2>
 290 <div class="doc-section">
 291
 292 <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>
 293
 294 <p>The format of the ReadImage method is:</p>
 295
 296 <pre class="code">
 297   Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
 298 </pre>
 299
 300 <p>A description of each parameter follows:</p>
 301
 302 <h5>image_info</h5>
 303 <p>Read the image defined by the file or filename members of this structure.</p>
 304
 305 <h5>exception</h5>
 306 <p>return any errors or warnings in this structure.</p>
 307
 308  </div>
 309 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="ReadImages">ReadImages</a></h2>
 310 <div class="doc-section">
 311
 312 <p>ReadImages() reads one or more images and returns them as an image list.</p>
 313
 314 <p>The format of the ReadImage method is:</p>
 315
 316 <pre class="code">
 317   Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
 318 </pre>
 319
 320 <p>A description of each parameter follows:</p>
 321
 322 <h5>image_info</h5>
 323 <p>the image info.</p>
 324
 325 <h5>exception</h5>
 326 <p>return any errors or warnings in this structure.</p>
 327
 328  </div>
 329 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="WriteImage">WriteImage</a></h2>
 330 <div class="doc-section">
 331
 332 <p>WriteImage() writes an image or an image sequence to a file or file handle. If writing to a file is on disk, the name is defined by the filename member of the image structure.  WriteImage() returns MagickFalse is there 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>
 333
 334 <p>The format of the WriteImage method is:</p>
 335
 336 <pre class="code">
 337   MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
 338 </pre>
 339
 340 <p>A description of each parameter follows:</p>
 341
 342 <h5>image_info</h5>
 343 <p>the image info.</p>
 344
 345 <h5>image</h5>
 346 <p>the image.</p>
 347
 348  </div>
 349 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute_8c.html" id="WriteImages">WriteImages</a></h2>
 350 <div class="doc-section">
 351
 352 <p>WriteImages() writes an image sequence into one or more files.  While WriteImage() can write an image sequence, it is limited to writing the sequence into a single file using a format which supports multiple frames.   WriteImages(), however, does not have this limitation, instead it generates multiple output files if necessary (or when requested).  When ImageInfo's adjoin flag is set to MagickFalse, the file name is expected to include a printf-style formatting string for the frame number (e.g. "image02d.png").</p>
 353
 354 <p>The format of the WriteImages method is:</p>
 355
 356 <pre class="code">
 357   MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
 358     const char *filename,ExceptionInfo *exception)
 359 </pre>
 360
 361 <p>A description of each parameter follows:</p>
 362
 363 <h5>image_info</h5>
 364 <p>the image info.</p>
 365
 366 <h5>images</h5>
 367 <p>the image list.</p>
 368
 369 <h5>filename</h5>
 370 <p>the image filename.</p>
 371
 372 <h5>exception</h5>
 373 <p>return any errors or warnings in this structure.</p>
 374
 375  </div>
 376 \r
 377 </div>\r
 378 \r
 379 <div id="linkbar">\r
 380     <span id="linkbar-west">&nbsp;</span>\r
 381     <span id="linkbar-center">\r
 382       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 383       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 384     </span>\r
 385     <span id="linkbar-east">&nbsp;</span>\r
 386   </div>\r
 387   <div class="footer">\r
 388     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 389     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 390   </div>\r
 391   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 392   <script type="text/javascript">\r
 393     var _gaq = _gaq || [];\r
 394     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 395     _gaq.push(['_trackPageview']);\r
 396 \r
 397     (function() {\r
 398       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 399       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 400       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 401     })();\r
 402   </script>\r
 403 </body>\r
 404 </html>\r