granicus.if.org Git - imagemagick/blob - www/api/image.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: Image Methods</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."/>
  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:, image, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  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 <a href="../../index.html">\r
  53   <img src="../../images/script.png" alt="[ImageMagick]"\r
  54   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  55 <a href="http://www.networkredux.com">\r
  56   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  57   style="margin-top: 42px; border: 0px; float: left;" /></a>\r
  58 <a href="http://www.imagemagick.org/discourse-server/">\r
  59   <img src="../../images/logo.jpg"\r
  60   alt="ImageMagick Logo"\r
  61   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  62 <a href="../../index.html">\r
  63   <img src="../../images/sprite.jpg"\r
  64   alt="ImageMagick Sprite"\r
  65   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  66 </div>\r
  67 \r
  68 <div class="westbar">\r
  69 \r
  70 <div class="menu">
  71   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  72 </div>
  73 <div class="sep"></div>\r
  74 <div class="menu">
  75   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  76 </div>
  77 <div class="sub">
  78     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  79 </div>
  80 <div class="sub">
  81     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  82 </div>
  83 <div class="sub">
  84     <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  88 </div>
  89 <div class="sep"></div>\r
  90 <div class="menu">
  91   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  92 </div>
  93 <div class="sub">
  94     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  95 </div>
  96 <div class="sub">
  97     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  98 </div>
  99 <div class="sub">
 100     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 101 </div>
 102 <div class="menu">
 103   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 104 </div>
 105 <div class="sub">
 106     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 107 </div>
 108 <div class="sub">
 109     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 110 </div>
 111 <div class="sub">
 112     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div  class="menu">
 119    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 120 </div>
 121 <div class="sub">
 122     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 123 </div>
 124 <div class="sub">
 125     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 126  </div>
 127 <div class="menu">
 128   <a title="Resources" href="../../www/resources.html">Resources</a>
 129 </div>
 130 <div class="menu">
 131   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 132 </div>
 133 <div class="menu">
 134   <a title="Download" href="../../www/download.html">Download</a>
 135 </div>
 136 <div class="sep"></div>\r
 137 <div class="menu">
 138   <a title="Search" href="../../www/search.html">Search</a>
 139 </div>
 140 <div class="sep"></div>\r
 141 <div class="menu">
 142   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 143 </div>
 144 <div  class="sub">
 145   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 146 </div>
 147 <div class="sep"></div>\r
 148 <div  class="menu">
 149   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 150
 151 <div class="sponsbox">
 152 <div  class="sponsor">
 153   <a title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 154 </div>
 155 <div  class="sponsor">
 156   <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201106010090 alexanian media -->
 157 </div>
 158 <div  class="sponsor">
 159   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
 160 </div>
 161 <div  class="sponsor">
 162   <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 163 </div>
 164 <div  class="sponsor">
 165   <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 166 </div>
 167 <div  class="sponsor">
 168   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 169 </div>
 170 <div class="sponsor">
 171   <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
 172 </div>
 173 <div  class="sponsor">
 174   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 175 </div>
 176 <div  class="sponsor">
 177    <a title="Sponsor: Custom T-Shirts" href="http://www.ooshirts.com">Custom T-Shirts</a><!-- 2011050100030 ooshirts.com-->
 178 </div>
 179 </div>
 180 </div>
 181 </div>\r
 182 \r
 183 <div class="eastbar">\r
 184   <script type="text/javascript">\r
 185   <!--\r
 186     google_ad_client = "pub-3129977114552745";\r
 187     google_ad_slot = "0574824969";\r
 188     google_ad_width = 160;\r
 189     google_ad_height = 600;\r
 190   //-->\r
 191   </script>\r
 192   <script type="text/javascript"\r
 193     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 194   </script>\r
 195 </div>\r
 196 \r
 197 <div class="main">\r
 198 \r
 199 <h1>Module image Methods</h1>
 200 <p class="navigation-index">[<a href="#AcquireImage">AcquireImage</a> &bull; <a href="#AcquireImageInfo">AcquireImageInfo</a> &bull; <a href="#AcquireNextImage">AcquireNextImage</a> &bull; <a href="#AppendImages">AppendImages</a> &bull; <a href="#CatchImageException">CatchImageException</a> &bull; <a href="#ClipImagePath">ClipImagePath</a> &bull; <a href="#CloneImage">CloneImage</a> &bull; <a href="#CloneImageInfo">CloneImageInfo</a> &bull; <a href="#CombineImages">CombineImages</a> &bull; <a href="#DestroyImage">DestroyImage</a> &bull; <a href="#DestroyImageInfo">DestroyImageInfo</a> &bull; <a href="#GetImageAlphaChannel">GetImageAlphaChannel</a> &bull; <a href="#GetImageClipMask">GetImageClipMask</a> &bull; <a href="#GetImageException">GetImageException</a> &bull; <a href="#GetImageInfo">GetImageInfo</a> &bull; <a href="#GetImageInfoFile">GetImageInfoFile</a> &bull; <a href="#GetImageMask">GetImageMask</a> &bull; <a href="#GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a> &bull; <a href="#InterpretImageFilename">InterpretImageFilename</a> &bull; <a href="#IsHighDynamicRangeImage">IsHighDynamicRangeImage</a> &bull; <a href="#IsImageObject">IsImageObject</a> &bull; <a href="#IsTaintImage">IsTaintImage</a> &bull; <a href="#ModifyImage">ModifyImage</a> &bull; <a href="#NewMagickImage">NewMagickImage</a> &bull; <a href="#ReferenceImage">ReferenceImage</a> &bull; <a href="#ResetImagePage">ResetImagePage</a> &bull; <a href="#SeparateImageChannel">SeparateImageChannel</a> &bull; <a href="#SeparateImages">SeparateImages</a> &bull; <a href="#SetImageAlphaChannel">SetImageAlphaChannel</a> &bull; <a href="#SetImageBackgroundColor">SetImageBackgroundColor</a> &bull; <a href="#SetImageColor">SetImageColor</a> &bull; <a href="#SetImageStorageClass">SetImageStorageClass</a> &bull; <a href="#SetImageClipMask">SetImageClipMask</a> &bull; <a href="#SetImageExtent">SetImageExtent</a> &bull; <a href="#SetImageInfoBlob">SetImageInfoBlob</a> &bull; <a href="#SetImageInfoFile">SetImageInfoFile</a> &bull; <a href="#SetImageMask">SetImageMask</a> &bull; <a href="#SetImageOpacity">SetImageOpacity</a> &bull; <a href="#SetImageType">SetImageType</a> &bull; <a href="#SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a> &bull; <a href="#SmushImages">SmushImages</a> &bull; <a href="#StripImage">StripImage</a> &bull; <a href="#SyncImageSettings">SyncImageSettings</a>]</p>
 201
 202 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AcquireImage">AcquireImage</a></h2>
 203 <div class="doc-section">
 204
 205 <p>AcquireImage() returns a pointer to an image structure initialized to default values.</p>
 206
 207 <p>The format of the AcquireImage method is:</p>
 208
 209 <pre class="code">
 210   Image *AcquireImage(const ImageInfo *image_info)
 211 </pre>
 212
 213 <p>A description of each parameter follows:</p>
 214
 215 <h5>image_info</h5>
 216 <p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p>
 217
 218  </div>
 219 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AcquireImageInfo">AcquireImageInfo</a></h2>
 220 <div class="doc-section">
 221
 222 <p>AcquireImageInfo() allocates the ImageInfo structure.</p>
 223
 224 <p>The format of the AcquireImageInfo method is:</p>
 225
 226 <pre class="code">
 227   ImageInfo *AcquireImageInfo(void)
 228 </pre>
 229
 230  </div>
 231 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AcquireNextImage">AcquireNextImage</a></h2>
 232 <div class="doc-section">
 233
 234 <p>AcquireNextImage() initializes the next image in a sequence to default values.  The next member of image points to the newly allocated image.  If there is a memory shortage, next is assigned NULL.</p>
 235
 236 <p>The format of the AcquireNextImage method is:</p>
 237
 238 <pre class="code">
 239   void AcquireNextImage(const ImageInfo *image_info,Image *image)
 240 </pre>
 241
 242 <p>A description of each parameter follows:</p>
 243
 244 <h5>image_info</h5>
 245 <p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p>
 246
 247 <h5>image</h5>
 248 <p>the image.</p>
 249
 250  </div>
 251 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="AppendImages">AppendImages</a></h2>
 252 <div class="doc-section">
 253
 254 <p>AppendImages() takes all images from the current image pointer to the end of the image list and appends them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.</p>
 255
 256 <p>The current gravity setting now effects how the image is justified in the final image.</p>
 257
 258 <p>The format of the AppendImages method is:</p>
 259
 260 <pre class="code">
 261   Image *AppendImages(const Image *images,const MagickBooleanType stack,
 262     ExceptionInfo *exception)
 263 </pre>
 264
 265 <p>A description of each parameter follows:</p>
 266
 267 <h5>images</h5>
 268 <p>the image sequence.</p>
 269
 270 <h5>stack</h5>
 271 <p>A value other than 0 stacks the images top-to-bottom.</p>
 272
 273 <h5>exception</h5>
 274 <p>return any errors or warnings in this structure.</p>
 275
 276  </div>
 277 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CatchImageException">CatchImageException</a></h2>
 278 <div class="doc-section">
 279
 280 <p>CatchImageException() returns if no exceptions are found in the image sequence, otherwise it determines the most severe exception and reports it as a warning or error depending on the severity.</p>
 281
 282 <p>The format of the CatchImageException method is:</p>
 283
 284 <pre class="code">
 285   ExceptionType CatchImageException(Image *image)
 286 </pre>
 287
 288 <p>A description of each parameter follows:</p>
 289
 290 <h5>image</h5>
 291 <p>An image sequence.</p>
 292
 293  </div>
 294 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ClipImagePath">ClipImagePath</a></h2>
 295 <div class="doc-section">
 296
 297 <p>ClipImagePath() sets the image clip mask based any clipping path information if it exists.</p>
 298
 299 <p>The format of the ClipImagePath method is:</p>
 300
 301 <pre class="code">
 302   MagickBooleanType ClipImagePath(Image *image,const char *pathname,
 303     const MagickBooleanType inside)
 304 </pre>
 305
 306 <p>A description of each parameter follows:</p>
 307
 308 <h5>image</h5>
 309 <p>the image.</p>
 310
 311 <h5>pathname</h5>
 312 <p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p>
 313
 314 <h5>inside</h5>
 315 <p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p>
 316
 317  </div>
 318 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CloneImage">CloneImage</a></h2>
 319 <div class="doc-section">
 320
 321 <p>CloneImage() copies an image and returns the copy as a new image object. If the specified columns and rows is 0, an exact copy of the image is returned, otherwise the pixel data is undefined and must be initialized with the QueueAuthenticPixels() and SyncAuthenticPixels() methods.  On failure, a NULL image is returned and exception describes the reason for the failure.</p>
 322
 323 <p>The format of the CloneImage method is:</p>
 324
 325 <pre class="code">
 326   Image *CloneImage(const Image *image,const size_t columns,
 327     const size_t rows,const MagickBooleanType orphan,
 328     ExceptionInfo *exception)
 329 </pre>
 330
 331 <p>A description of each parameter follows:</p>
 332
 333 <h5>image</h5>
 334 <p>the image.</p>
 335
 336 <h5>columns</h5>
 337 <p>the number of columns in the cloned image.</p>
 338
 339 <h5>rows</h5>
 340 <p>the number of rows in the cloned image.</p>
 341
 342 <h5>detach</h5>
 343 <p>With a value other than 0, the cloned image is detached from its parent I/O stream.</p>
 344
 345 <h5>exception</h5>
 346 <p>return any errors or warnings in this structure.</p>
 347
 348  </div>
 349 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CloneImageInfo">CloneImageInfo</a></h2>
 350 <div class="doc-section">
 351
 352 <p>CloneImageInfo() makes a copy of the given image info structure.  If NULL is specified, a new image info structure is created initialized to default values.</p>
 353
 354 <p>The format of the CloneImageInfo method is:</p>
 355
 356 <pre class="code">
 357   ImageInfo *CloneImageInfo(const ImageInfo *image_info)
 358 </pre>
 359
 360 <p>A description of each parameter follows:</p>
 361
 362 <h5>image_info</h5>
 363 <p>the image info.</p>
 364
 365  </div>
 366 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="CombineImages">CombineImages</a></h2>
 367 <div class="doc-section">
 368
 369 <p>CombineImages() combines one or more images into a single image.  The grayscale value of the pixels of each image in the sequence is assigned in order to the specified channels of the combined image.   The typical ordering would be image 1 => Red, 2 => Green, 3 => Blue, etc.</p>
 370
 371 <p>The format of the CombineImages method is:</p>
 372
 373 <pre class="code">
 374   Image *CombineImages(const Image *image,const ChannelType channel,
 375     ExceptionInfo *exception)
 376 </pre>
 377
 378 <p>A description of each parameter follows:</p>
 379
 380 <h5>image</h5>
 381 <p>the image.</p>
 382
 383 <h5>exception</h5>
 384 <p>return any errors or warnings in this structure.</p>
 385
 386  </div>
 387 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="DestroyImage">DestroyImage</a></h2>
 388 <div class="doc-section">
 389
 390 <p>DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p>
 391
 392 <p>The format of the DestroyImage method is:</p>
 393
 394 <pre class="code">
 395   Image *DestroyImage(Image *image)
 396 </pre>
 397
 398 <p>A description of each parameter follows:</p>
 399
 400 <h5>image</h5>
 401 <p>the image.</p>
 402
 403  </div>
 404 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="DestroyImageInfo">DestroyImageInfo</a></h2>
 405 <div class="doc-section">
 406
 407 <p>DestroyImageInfo() deallocates memory associated with an ImageInfo structure.</p>
 408
 409 <p>The format of the DestroyImageInfo method is:</p>
 410
 411 <pre class="code">
 412   ImageInfo *DestroyImageInfo(ImageInfo *image_info)
 413 </pre>
 414
 415 <p>A description of each parameter follows:</p>
 416
 417 <h5>image_info</h5>
 418 <p>the image info.</p>
 419
 420  </div>
 421 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageAlphaChannel">GetImageAlphaChannel</a></h2>
 422 <div class="doc-section">
 423
 424 <p>GetImageAlphaChannel() returns MagickFalse if the image alpha channel is not activated.  That is, the image is RGB rather than RGBA or CMYK rather than CMYKA.</p>
 425
 426 <p>The format of the GetImageAlphaChannel method is:</p>
 427
 428 <pre class="code">
 429   MagickBooleanType GetImageAlphaChannel(const Image *image)
 430 </pre>
 431
 432 <p>A description of each parameter follows:</p>
 433
 434 <h5>image</h5>
 435 <p>the image.</p>
 436
 437  </div>
 438 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageClipMask">GetImageClipMask</a></h2>
 439 <div class="doc-section">
 440
 441 <p>GetImageClipMask() returns the clip path associated with the image.</p>
 442
 443 <p>The format of the GetImageClipMask method is:</p>
 444
 445 <pre class="code">
 446   Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
 447 </pre>
 448
 449 <p>A description of each parameter follows:</p>
 450
 451 <h5>image</h5>
 452 <p>the image.</p>
 453
 454  </div>
 455 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageException">GetImageException</a></h2>
 456 <div class="doc-section">
 457
 458 <p>GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.</p>
 459
 460 <p>The format of the GetImageException method is:</p>
 461
 462 <pre class="code">
 463   void GetImageException(Image *image,ExceptionInfo *exception)
 464 </pre>
 465
 466 <p>A description of each parameter follows:</p>
 467
 468 <h5>image</h5>
 469 <p>Specifies a pointer to a list of one or more images.</p>
 470
 471 <h5>exception</h5>
 472 <p>return the highest severity exception.</p>
 473
 474  </div>
 475 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageInfo">GetImageInfo</a></h2>
 476 <div class="doc-section">
 477
 478 <p>GetImageInfo() initializes image_info to default values.</p>
 479
 480 <p>The format of the GetImageInfo method is:</p>
 481
 482 <pre class="code">
 483   void GetImageInfo(ImageInfo *image_info)
 484 </pre>
 485
 486 <p>A description of each parameter follows:</p>
 487
 488 <h5>image_info</h5>
 489 <p>the image info.</p>
 490
 491  </div>
 492 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageInfoFile">GetImageInfoFile</a></h2>
 493 <div class="doc-section">
 494
 495 <p>GetImageInfoFile() returns the image info file member.</p>
 496
 497 <p>The format of the GetImageInfoFile method is:</p>
 498
 499 <pre class="code">
 500   FILE *GetImageInfoFile(const ImageInfo *image_info)
 501 </pre>
 502
 503 <p>A description of each parameter follows:</p>
 504
 505 <h5>image_info</h5>
 506 <p>the image info.</p>
 507
 508  </div>
 509 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageMask">GetImageMask</a></h2>
 510 <div class="doc-section">
 511
 512 <p>GetImageMask() returns the mask associated with the image.</p>
 513
 514 <p>The format of the GetImageMask method is:</p>
 515
 516 <pre class="code">
 517   Image *GetImageMask(const Image *image,ExceptionInfo *exception)
 518 </pre>
 519
 520 <p>A description of each parameter follows:</p>
 521
 522 <h5>image</h5>
 523 <p>the image.</p>
 524
 525  </div>
 526 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a></h2>
 527 <div class="doc-section">
 528
 529 <p>GetImageVirtualPixelMethod() gets the "virtual pixels" method for the image.  A virtual pixel is any pixel access that is outside the boundaries of the image cache.</p>
 530
 531 <p>The format of the GetImageVirtualPixelMethod() method is:</p>
 532
 533 <pre class="code">
 534   VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
 535 </pre>
 536
 537 <p>A description of each parameter follows:</p>
 538
 539 <h5>image</h5>
 540 <p>the image.</p>
 541
 542  </div>
 543 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="InterpretImageFilename">InterpretImageFilename</a></h2>
 544 <div class="doc-section">
 545
 546 <p>InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.</p>
 547
 548 <p>The format of the InterpretImageFilename method is:</p>
 549
 550 <pre class="code">
 551   size_t InterpretImageFilename(const ImageInfo *image_info,
 552     Image *image,const char *format,int value,char *filename)
 553 </pre>
 554
 555 <p>A description of each parameter follows.</p>
 556
 557 <h5>image_info</h5>
 558 <p>the image info..</p>
 559
 560 <h5>image</h5>
 561 <p>the image.</p>
 562
 563 <h5>format</h5>
 564 <p>A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.</p>
 565
 566 <h5>value</h5>
 567 <p>Numeric value to substitute into format filename.</p>
 568
 569 <h5>filename</h5>
 570 <p>return the formatted filename in this character buffer.</p>
 571
 572  </div>
 573 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="IsHighDynamicRangeImage">IsHighDynamicRangeImage</a></h2>
 574 <div class="doc-section">
 575
 576 <p>IsHighDynamicRangeImage() returns MagickTrue if any pixel component is non-integer or exceeds the bounds of the quantum depth (e.g. for Q16 0..65535.</p>
 577
 578 <p>The format of the IsHighDynamicRangeImage method is:</p>
 579
 580 <pre class="code">
 581   MagickBooleanType IsHighDynamicRangeImage(const Image *image,
 582     ExceptionInfo *exception)
 583 </pre>
 584
 585 <p>A description of each parameter follows:</p>
 586
 587 <h5>image</h5>
 588 <p>the image.</p>
 589
 590 <h5>exception</h5>
 591 <p>return any errors or warnings in this structure.</p>
 592
 593  </div>
 594 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="IsImageObject">IsImageObject</a></h2>
 595 <div class="doc-section">
 596
 597 <p>IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.</p>
 598
 599 <p>The format of the IsImageObject method is:</p>
 600
 601 <pre class="code">
 602   MagickBooleanType IsImageObject(const Image *image)
 603 </pre>
 604
 605 <p>A description of each parameter follows:</p>
 606
 607 <h5>image</h5>
 608 <p>the image.</p>
 609
 610  </div>
 611 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="IsTaintImage">IsTaintImage</a></h2>
 612 <div class="doc-section">
 613
 614 <p>IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.</p>
 615
 616 <p>The format of the IsTaintImage method is:</p>
 617
 618 <pre class="code">
 619   MagickBooleanType IsTaintImage(const Image *image)
 620 </pre>
 621
 622 <p>A description of each parameter follows:</p>
 623
 624 <h5>image</h5>
 625 <p>the image.</p>
 626
 627  </div>
 628 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ModifyImage">ModifyImage</a></h2>
 629 <div class="doc-section">
 630
 631 <p>ModifyImage() ensures that there is only a single reference to the image to be modified, updating the provided image pointer to point to a clone of the original image if necessary.</p>
 632
 633 <p>The format of the ModifyImage method is:</p>
 634
 635 <pre class="code">
 636   MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
 637 </pre>
 638
 639 <p>A description of each parameter follows:</p>
 640
 641 <h5>image</h5>
 642 <p>the image.</p>
 643
 644 <h5>exception</h5>
 645 <p>return any errors or warnings in this structure.</p>
 646
 647  </div>
 648 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="NewMagickImage">NewMagickImage</a></h2>
 649 <div class="doc-section">
 650
 651 <p>NewMagickImage() creates a blank image canvas of the specified size and background color.</p>
 652
 653 <p>The format of the NewMagickImage method is:</p>
 654
 655 <pre class="code">
 656   Image *NewMagickImage(const ImageInfo *image_info,
 657     const size_t width,const size_t height,
 658     const MagickPixelPacket *background)
 659 </pre>
 660
 661 <p>A description of each parameter follows:</p>
 662
 663 <h5>image</h5>
 664 <p>the image.</p>
 665
 666 <h5>width</h5>
 667 <p>the image width.</p>
 668
 669 <h5>height</h5>
 670 <p>the image height.</p>
 671
 672 <h5>background</h5>
 673 <p>the image color.</p>
 674
 675  </div>
 676 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ReferenceImage">ReferenceImage</a></h2>
 677 <div class="doc-section">
 678
 679 <p>ReferenceImage() increments the reference count associated with an image returning a pointer to the image.</p>
 680
 681 <p>The format of the ReferenceImage method is:</p>
 682
 683 <pre class="code">
 684   Image *ReferenceImage(Image *image)
 685 </pre>
 686
 687 <p>A description of each parameter follows:</p>
 688
 689 <h5>image</h5>
 690 <p>the image.</p>
 691
 692  </div>
 693 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="ResetImagePage">ResetImagePage</a></h2>
 694 <div class="doc-section">
 695
 696 <p>ResetImagePage() resets the image page canvas and position.</p>
 697
 698 <p>The format of the ResetImagePage method is:</p>
 699
 700 <pre class="code">
 701   MagickBooleanType ResetImagePage(Image *image,const char *page)
 702 </pre>
 703
 704 <p>A description of each parameter follows:</p>
 705
 706 <h5>image</h5>
 707 <p>the image.</p>
 708
 709 <h5>page</h5>
 710 <p>the relative page specification.</p>
 711
 712  </div>
 713 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SeparateImageChannel">SeparateImageChannel</a></h2>
 714 <div class="doc-section">
 715
 716 <p>SeparateImageChannel() separates a channel from the image and returns it as a grayscale image.  A channel is a particular color component of each pixel in the image.</p>
 717
 718 <p>The format of the SeparateImageChannel method is:</p>
 719
 720 <pre class="code">
 721   MagickBooleanType SeparateImageChannel(Image *image,
 722     const ChannelType channel)
 723 </pre>
 724
 725 <p>A description of each parameter follows:</p>
 726
 727 <h5>image</h5>
 728 <p>the image.</p>
 729
 730 <h5>channel</h5>
 731 <p>Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p>
 732
 733  </div>
 734 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SeparateImages">SeparateImages</a></h2>
 735 <div class="doc-section">
 736
 737 <p>SeparateImages() returns a separate grayscale image for each channel specified.</p>
 738
 739 <p>The format of the SeparateImages method is:</p>
 740
 741 <pre class="code">
 742   MagickBooleanType SeparateImages(const Image *image,
 743     const ChannelType channel,ExceptionInfo *exception)
 744 </pre>
 745
 746 <p>A description of each parameter follows:</p>
 747
 748 <h5>image</h5>
 749 <p>the image.</p>
 750
 751 <h5>channel</h5>
 752 <p>Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p>
 753
 754 <h5>exception</h5>
 755 <p>return any errors or warnings in this structure.</p>
 756
 757  </div>
 758 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageAlphaChannel">SetImageAlphaChannel</a></h2>
 759 <div class="doc-section">
 760
 761 <p>SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p>
 762
 763 <p>The format of the SetImageAlphaChannel method is:</p>
 764
 765 <pre class="code">
 766   MagickBooleanType SetImageAlphaChannel(Image *image,
 767     const AlphaChannelType alpha_type)
 768 </pre>
 769
 770 <p>A description of each parameter follows:</p>
 771
 772 <h5>image</h5>
 773 <p>the image.</p>
 774
 775 <h5>alpha_type</h5>
 776 <p>The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.</p>
 777
 778  </div>
 779 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageBackgroundColor">SetImageBackgroundColor</a></h2>
 780 <div class="doc-section">
 781
 782 <p>SetImageBackgroundColor() initializes the image pixels to the image background color.  The background color is defined by the background_color member of the image structure.</p>
 783
 784 <p>The format of the SetImage method is:</p>
 785
 786 <pre class="code">
 787   MagickBooleanType SetImageBackgroundColor(Image *image)
 788 </pre>
 789
 790 <p>A description of each parameter follows:</p>
 791
 792 <h5>image</h5>
 793 <p>the image.</p>
 794
 795  </div>
 796 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageColor">SetImageColor</a></h2>
 797 <div class="doc-section">
 798
 799 <p>SetImageColor() set the entire image canvas to the specified color.</p>
 800
 801 <p>The format of the SetImageColor method is:</p>
 802
 803 <pre class="code">
 804   MagickBooleanType SetImageColor(Image *image,
 805     const MagickPixelPacket *color)
 806 </pre>
 807
 808 <p>A description of each parameter follows:</p>
 809
 810 <h5>image</h5>
 811 <p>the image.</p>
 812
 813 <h5>background</h5>
 814 <p>the image color.</p>
 815
 816  </div>
 817 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageStorageClass">SetImageStorageClass</a></h2>
 818 <div class="doc-section">
 819
 820 <p>SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.</p>
 821
 822 <p>The format of the SetImageStorageClass method is:</p>
 823
 824 <pre class="code">
 825   MagickBooleanType SetImageStorageClass(Image *image,
 826     const ClassType storage_class)
 827 </pre>
 828
 829 <p>A description of each parameter follows:</p>
 830
 831 <h5>image</h5>
 832 <p>the image.</p>
 833
 834 <h5>storage_class</h5>
 835 <p>The image class.</p>
 836
 837  </div>
 838 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageClipMask">SetImageClipMask</a></h2>
 839 <div class="doc-section">
 840
 841 <p>SetImageClipMask() associates a clip path with the image.  The clip path must be the same dimensions as the image.  Set any pixel component of the clip path to TransparentOpacity to prevent that corresponding image pixel component from being updated when SyncAuthenticPixels() is applied.</p>
 842
 843 <p>The format of the SetImageClipMask method is:</p>
 844
 845 <pre class="code">
 846   MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
 847 </pre>
 848
 849 <p>A description of each parameter follows:</p>
 850
 851 <h5>image</h5>
 852 <p>the image.</p>
 853
 854 <h5>clip_mask</h5>
 855 <p>the image clip path.</p>
 856
 857  </div>
 858 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageExtent">SetImageExtent</a></h2>
 859 <div class="doc-section">
 860
 861 <p>SetImageExtent() sets the image size (i.e. columns & rows).</p>
 862
 863 <p>The format of the SetImageExtent method is:</p>
 864
 865 <pre class="code">
 866   MagickBooleanType SetImageExtent(Image *image,
 867     const size_t columns,const size_t rows)
 868 </pre>
 869
 870 <p>A description of each parameter follows:</p>
 871
 872 <h5>image</h5>
 873 <p>the image.</p>
 874
 875 <h5>columns</h5>
 876 <p>The image width in pixels.</p>
 877
 878 <h5>rows</h5>
 879 <p>The image height in pixels.</p>
 880
 881  </div>
 882 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageInfoBlob">SetImageInfoBlob</a></h2>
 883 <div class="doc-section">
 884
 885 <p>SetImageInfoBlob() sets the image info blob member.</p>
 886
 887 <p>The format of the SetImageInfoBlob method is:</p>
 888
 889 <pre class="code">
 890   void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
 891     const size_t length)
 892 </pre>
 893
 894 <p>A description of each parameter follows:</p>
 895
 896 <h5>image_info</h5>
 897 <p>the image info.</p>
 898
 899 <h5>blob</h5>
 900 <p>the blob.</p>
 901
 902 <h5>length</h5>
 903 <p>the blob length.</p>
 904
 905  </div>
 906 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageInfoFile">SetImageInfoFile</a></h2>
 907 <div class="doc-section">
 908
 909 <p>SetImageInfoFile() sets the image info file member.</p>
 910
 911 <p>The format of the SetImageInfoFile method is:</p>
 912
 913 <pre class="code">
 914   void SetImageInfoFile(ImageInfo *image_info,FILE *file)
 915 </pre>
 916
 917 <p>A description of each parameter follows:</p>
 918
 919 <h5>image_info</h5>
 920 <p>the image info.</p>
 921
 922 <h5>file</h5>
 923 <p>the file.</p>
 924
 925  </div>
 926 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageMask">SetImageMask</a></h2>
 927 <div class="doc-section">
 928
 929 <p>SetImageMask() associates a mask with the image.  The mask must be the same dimensions as the image.</p>
 930
 931 <p>The format of the SetImageMask method is:</p>
 932
 933 <pre class="code">
 934   MagickBooleanType SetImageMask(Image *image,const Image *mask)
 935 </pre>
 936
 937 <p>A description of each parameter follows:</p>
 938
 939 <h5>image</h5>
 940 <p>the image.</p>
 941
 942 <h5>mask</h5>
 943 <p>the image mask.</p>
 944
 945  </div>
 946 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageOpacity">SetImageOpacity</a></h2>
 947 <div class="doc-section">
 948
 949 <p>SetImageOpacity() sets the opacity levels of the image.</p>
 950
 951 <p>The format of the SetImageOpacity method is:</p>
 952
 953 <pre class="code">
 954   MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
 955 </pre>
 956
 957 <p>A description of each parameter follows:</p>
 958
 959 <h5>image</h5>
 960 <p>the image.</p>
 961
 962 <h5>opacity</h5>
 963 <p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p>
 964
 965  </div>
 966 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageType">SetImageType</a></h2>
 967 <div class="doc-section">
 968
 969 <p>SetImageType() sets the type of image.  Choose from these types:</p>
 970
 971 <p>Bilevel        Grayscale       GrayscaleMatte Palette        PaletteMatte    TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte OptimizeType</p>
 972
 973 <p>The format of the SetImageType method is:</p>
 974
 975 <pre class="code">
 976   MagickBooleanType SetImageType(Image *image,const ImageType type)
 977 </pre>
 978
 979 <p>A description of each parameter follows:</p>
 980
 981 <h5>image</h5>
 982 <p>the image.</p>
 983
 984 <h5>type</h5>
 985 <p>Image type.</p>
 986
 987  </div>
 988 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a></h2>
 989 <div class="doc-section">
 990
 991 <p>SetImageVirtualPixelMethod() sets the "virtual pixels" method for the image and returns the previous setting.  A virtual pixel is any pixel access that is outside the boundaries of the image cache.</p>
 992
 993 <p>The format of the SetImageVirtualPixelMethod() method is:</p>
 994
 995 <pre class="code">
 996   VirtualPixelMethod SetImageVirtualPixelMethod(const Image *image,
 997     const VirtualPixelMethod virtual_pixel_method)
 998 </pre>
 999
1000 <p>A description of each parameter follows:</p>
1001
1002 <h5>image</h5>
1003 <p>the image.</p>
1004
1005 <h5>virtual_pixel_method</h5>
1006 <p>choose the type of virtual pixel.</p>
1007
1008  </div>
1009 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SmushImages">SmushImages</a></h2>
1010 <div class="doc-section">
1011
1012 <p>SmushImages() takes all images from the current image pointer to the end of the image list and smushes them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.</p>
1013
1014 <p>The current gravity setting now effects how the image is justified in the final image.</p>
1015
1016 <p>The format of the SmushImages method is:</p>
1017
1018 <pre class="code">
1019   Image *SmushImages(const Image *images,const MagickBooleanType stack,
1020     ExceptionInfo *exception)
1021 </pre>
1022
1023 <p>A description of each parameter follows:</p>
1024
1025 <h5>images</h5>
1026 <p>the image sequence.</p>
1027
1028 <h5>stack</h5>
1029 <p>A value other than 0 stacks the images top-to-bottom.</p>
1030
1031 <h5>offset</h5>
1032 <p>minimum distance in pixels between images.</p>
1033
1034 <h5>exception</h5>
1035 <p>return any errors or warnings in this structure.</p>
1036
1037  </div>
1038 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="StripImage">StripImage</a></h2>
1039 <div class="doc-section">
1040
1041 <p>StripImage() strips an image of all profiles and comments.</p>
1042
1043 <p>The format of the StripImage method is:</p>
1044
1045 <pre class="code">
1046   MagickBooleanType StripImage(Image *image)
1047 </pre>
1048
1049 <p>A description of each parameter follows:</p>
1050
1051 <h5>image</h5>
1052 <p>the image.</p>
1053
1054  </div>
1055 <h2><a href="http://www.imagemagick.org/api/MagickCore/image_8c.html" id="SyncImageSettings">SyncImageSettings</a></h2>
1056 <div class="doc-section">
1057
1058 <p>SyncImageSettings() sync the image info options to the image.</p>
1059
1060 <p>The format of the SyncImageSettings method is:</p>
1061
1062 <pre class="code">
1063   MagickBooleanType SyncImageSettings(const ImageInfo *image_info,
1064     Image *image)
1065   MagickBooleanType SyncImagesSettings(const ImageInfo *image_info,
1066     Image *image)
1067 </pre>
1068
1069 <p>A description of each parameter follows:</p>
1070
1071 <h5>image_info</h5>
1072 <p>the image info.</p>
1073
1074 <h5>image</h5>
1075 <p>the image.</p>
1076
1077  </div>
1078 \r
1079 </div>\r
1080 \r
1081 <div id="linkbar">\r
1082     <span id="linkbar-west">&nbsp;</span>\r
1083     <span id="linkbar-center">\r
1084       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
1085       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
1086     </span>\r
1087     <span id="linkbar-east">&nbsp;</span>\r
1088   </div>\r
1089   <div class="footer">\r
1090     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
1091     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
1092   </div>\r
1093   <div style="clear: both; margin: 0; width: 100%; "></div>\r
1094   <script type="text/javascript">\r
1095     var _gaq = _gaq || [];\r
1096     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
1097     _gaq.push(['_trackPageview']);\r
1098 \r
1099     (function() {\r
1100       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
1101       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
1102       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
1103     })();\r
1104   </script>\r
1105 </body>\r
1106 </html>\r