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 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
   7   <title>ImageMagick: MagickCore, C API for ImageMagick: Constitute an Image</title>
   8   <meta http-equiv="Content-Language" content="en-US"/>
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  10   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  11   <meta name="Application-name" content="ImageMagick"/>
  12   <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
  13   <meta name="Application-url" content="http://www.imagemagick.org"/>
  14   <meta name="Generator" content="PHP"/>
  15   <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"/>
  16   <meta name="Rating" content="GENERAL"/>
  17   <meta name="Robots" content="INDEX, FOLLOW"/>
  18   <meta name="Generator" content="ImageMagick Studio LLC"/>
  19   <meta name="Author" content="ImageMagick Studio LLC"/>
  20   <meta name="Revisit-after" content="2 DAYS"/>
  21   <meta name="Resource-type" content="document"/>
  22   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../../images/wand.png"/>
  25   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  26   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  27   <style type="text/css" media="all">\r
  28     @import url("../../www/magick.css");\r
  29   </style>\r
  30   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  31   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  32   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  33   <script type="text/javascript">\r
  34     $(document).ready(function() {\r
  35       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  36         'transitionIn'  : 'elastic',\r
  37         'transitionOut' : 'elastic',\r
  38         'overlayShow'   : false,\r
  39         'opacity'       : true\r
  40       });\r
  41     });\r
  42   </script>\r
  43 </head>\r
  44 \r
  45 <body id="www-imagemagick-org">\r
  46 <div class="titlebar">\r
  47 <a href="../../index.html">\r
  48   <img src="../../images/script.png" alt="[ImageMagick]"\r
  49   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  50 <a href="http://www.networkredux.com">\r
  51   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  52   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  53 <a href="http://www.imagemagick.org/discourse-server/">\r
  54   <img src="../../images/logo.jpg" alt=""\r
  55   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  56 <a href="../../index.html">\r
  57   <img src="../../images/sprite.jpg" alt=""\r
  58   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  59 </div>\r
  60 \r
  61 <div class="westbar">\r
  62 \r
  63 <div class="menu">
  64   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  65 </div>
  66 <div class="sep"></div>\r
  67 <div class="menu">
  68   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  78 </div>
  79 <div class="sep"></div>\r
  80 <div class="menu">
  81   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  82 </div>
  83 <div class="sub">
  84     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  88 </div>
  89 <div class="sub">
  90     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  91 </div>
  92 <div class="menu">
  93   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 103 </div>
 104 <div class="sub">
 105     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 106 </div>
 107 <div class="sep"></div>\r
 108 <div  class="menu">
 109    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 110 </div>
 111 <div class="sub">
 112     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 116  </div>
 117 <div class="menu">
 118   <a title="Resources" href="../../www/resources.html">Resources</a>
 119 </div>
 120 <div class="menu">
 121   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 122 </div>
 123 <div class="menu">
 124   <a title="Download" href="../../www/download.html">Download</a>
 125 </div>
 126 <div class="sep"></div>\r
 127 <div class="menu">
 128   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 129 </div>
 130 <div class="sep"></div>\r
 131 <div class="menu">
 132   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 133 </div>
 134 <div  class="sub">
 135   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 136 </div>
 137 <div class="sep"></div>\r
 138 <div  class="menu">
 139   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 140
 141 <div class="sponsbox">
 142 <div class="sponsor">
 143   <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.html">Web Hosting</a><!-- 201104010090 -->
 144 </div>
 145 <div  class="sponsor">
 146   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 147 </div>
 148 <div  class="sponsor">
 149   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 150 </div>
 151 <div  class="sponsor">
 152   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 153 </div>
 154 <div  class="sponsor">
 155    <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011050100025 atlas.multimedia-->
 156 </div>
 157 </div>
 158 </div>
 159 </div>\r
 160 \r
 161 <div class="eastbar">\r
 162   <script type="text/javascript">\r
 163   <!--\r
 164     google_ad_client = "pub-3129977114552745";\r
 165     google_ad_slot = "0574824969";\r
 166     google_ad_width = 160;\r
 167     google_ad_height = 600;\r
 168   //-->\r
 169   </script>\r
 170   <script type="text/javascript"\r
 171     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 172   </script>\r
 173 </div>\r
 174 \r
 175 <div class="main">\r
 176 \r
 177 <h1>Module constitute
 178  Methods</h1>
 179 <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>
 180
 181 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 182 _8c.html" target="source" name="ConstituteImage">ConstituteImage</a></h2>
 183 <div class="doc-section">
 184
 185 <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>
 186
 187 <pre class="text">
 188   image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
 189 </pre>
 190
 191 <p>The format of the ConstituteImage method is:</p>
 192
 193 <pre class="code">
 194   Image *ConstituteImage(const size_t columns,const size_t rows,
 195     const char *map,const StorageType storage,const void *pixels,
 196     ExceptionInfo *exception)
 197 </pre>
 198
 199 <p>A description of each parameter follows:</p></ol>
 200
 201 <h5>columns</h5>
 202 <ol><p>width in pixels of the image.</p></ol>
 203
 204 <h5>rows</h5>
 205 <ol><p>height in pixels of the image.</p></ol>
 206
 207 <h5>map</h5>
 208 <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>
 209
 210 <h5>storage</h5>
 211 <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>
 212
 213 <h5>pixels</h5>
 214 <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>
 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="PingImage">PingImage</a></h2>
 222 <div class="doc-section">
 223
 224 <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>
 225
 226 <p>The format of the PingImage method is:</p>
 227
 228 <pre class="code">
 229   Image *PingImage(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>Ping the image defined by the file or filename members of this structure.</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="PingImages">PingImages</a></h2>
 243 <div class="doc-section">
 244
 245 <p>PingImages() pings one or more images and returns them as an image list.</p></ol>
 246
 247 <p>The format of the PingImage method is:</p>
 248
 249 <pre class="code">
 250   Image *PingImages(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>the image info.</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="ReadImage">ReadImage</a></h2>
 264 <div class="doc-section">
 265
 266 <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>
 267
 268 <p>The format of the ReadImage method is:</p>
 269
 270 <pre class="code">
 271   Image *ReadImage(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>Read the image defined by the file or filename members of this structure.</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="ReadImages">ReadImages</a></h2>
 285 <div class="doc-section">
 286
 287 <p>ReadImages() reads one or more images and returns them as an image list.</p></ol>
 288
 289 <p>The format of the ReadImage method is:</p>
 290
 291 <pre class="code">
 292   Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
 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>exception</h5>
 301 <ol><p>return any errors or warnings in this structure.</p></ol>
 302
 303  </div>
 304 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 305 _8c.html" target="source" name="WriteImage">WriteImage</a></h2>
 306 <div class="doc-section">
 307
 308 <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>
 309
 310 <p>The format of the WriteImage method is:</p>
 311
 312 <pre class="code">
 313   MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
 314 </pre>
 315
 316 <p>A description of each parameter follows:</p></ol>
 317
 318 <h5>image_info</h5>
 319 <ol><p>the image info.</p></ol>
 320
 321 <h5>image</h5>
 322 <ol><p>the image.</p></ol>
 323
 324  </div>
 325 <h2><a href="http://www.imagemagick.org/api/MagickCore/constitute
 326 _8c.html" target="source" name="WriteImages">WriteImages</a></h2>
 327 <div class="doc-section">
 328
 329 <p>WriteImages() writes an image sequence.</p></ol>
 330
 331 <p>The format of the WriteImages method is:</p>
 332
 333 <pre class="code">
 334   MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
 335     const char *filename,ExceptionInfo *exception)
 336 </pre>
 337
 338 <p>A description of each parameter follows:</p></ol>
 339
 340 <h5>image_info</h5>
 341 <ol><p>the image info.</p></ol>
 342
 343 <h5>images</h5>
 344 <ol><p>the image list.</p></ol>
 345
 346 <h5>filename</h5>
 347 <ol><p>the image filename.</p></ol>
 348
 349 <h5>exception</h5>
 350 <ol><p>return any errors or warnings in this structure.</p></ol>
 351
 352  </div>
 353 \r
 354 </div>\r
 355 \r
 356 <div id="linkbar">\r
 357     <span id="linkbar-west">&nbsp;</span>\r
 358     <span id="linkbar-center">\r
 359       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 360       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 361     </span>\r
 362     <span id="linkbar-east">&nbsp;</span>\r
 363   </div>\r
 364   <div class="footer">\r
 365     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 366     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 367   </div>\r
 368   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 369   <script type="text/javascript">\r
 370     var _gaq = _gaq || [];\r
 371     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 372     _gaq.push(['_trackPageview']);\r
 373 \r
 374     (function() {\r
 375       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 376       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 377       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 378     })();\r
 379   </script>\r
 380 </body>\r
 381 </html>\r