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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: 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="Generator" content="PHP"/>
  16   <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"/>
  17   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.buerodruck.de/stempel-service/index.html">Stempel bestellen</a><!-- 200910000035+ -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 133 </div>
 134 <div  class="sponsor">
 135    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <p class="navigation-index">[<a href="#AcquireImage">AcquireImage</a> &bull; <a href="#AcquireImageColormap">AcquireImageColormap</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="#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="#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="#StripImage">StripImage</a>]</p>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 157 _8c.html" target="source" name="AcquireImage">AcquireImage</a></h2>
 158 <div class="doc-section">
 159
 160 <p>AcquireImage() returns a pointer to an image structure initialized to default values.</p></ol>
 161
 162 <p>The format of the AcquireImage method is:</p>
 163
 164 <pre class="code">
 165   Image *AcquireImage(const ImageInfo *image_info)
 166 </pre>
 167
 168 <p>A description of each parameter follows:</p></ol>
 169
 170 <h5>image_info</h5>
 171 <ol><p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p></ol>
 172
 173  </div>
 174 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 175 _8c.html" target="source" name="AcquireImageColormap">AcquireImageColormap</a></h2>
 176 <div class="doc-section">
 177
 178 <p>AcquireImageColormap() allocates an image colormap and initializes it to a linear gray colorspace.  If the image already has a colormap, it is replaced.  AcquireImageColormap() returns MagickTrue if successful, otherwise MagickFalse if there is not enough memory.</p></ol>
 179
 180 <p>The format of the AcquireImageColormap method is:</p>
 181
 182 <pre class="code">
 183   MagickBooleanType AcquireImageColormap(Image *image,
 184     const unsigned long colors)
 185 </pre>
 186
 187 <p>A description of each parameter follows:</p></ol>
 188
 189 <h5>image</h5>
 190 <ol><p>the image.</p></ol>
 191
 192 <h5>colors</h5>
 193 <ol><p>the number of colors in the image colormap.</p></ol>
 194
 195  </div>
 196 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 197 _8c.html" target="source" name="AcquireImageInfo">AcquireImageInfo</a></h2>
 198 <div class="doc-section">
 199
 200 <p>AcquireImageInfo() allocates the ImageInfo structure.</p></ol>
 201
 202 <p>The format of the AcquireImageInfo method is:</p>
 203
 204 <pre class="code">
 205   ImageInfo *AcquireImageInfo(void)
 206 </pre>
 207
 208  </div>
 209 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 210 _8c.html" target="source" name="AcquireNextImage">AcquireNextImage</a></h2>
 211 <div class="doc-section">
 212
 213 <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></ol>
 214
 215 <p>The format of the AcquireNextImage method is:</p>
 216
 217 <pre class="code">
 218   void AcquireNextImage(const ImageInfo *image_info,Image *image)
 219 </pre>
 220
 221 <p>A description of each parameter follows:</p></ol>
 222
 223 <h5>image_info</h5>
 224 <ol><p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p></ol>
 225
 226 <h5>image</h5>
 227 <ol><p>the image.</p></ol>
 228
 229  </div>
 230 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 231 _8c.html" target="source" name="AppendImages">AppendImages</a></h2>
 232 <div class="doc-section">
 233
 234 <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></ol>
 235
 236 <p>The current gravity setting now effects how the image is justified in the final image.</p></ol>
 237
 238 <p>The format of the AppendImages method is:</p>
 239
 240 <pre class="code">
 241   Image *AppendImages(const Image *image,const MagickBooleanType stack,
 242     ExceptionInfo *exception)
 243 </pre>
 244
 245 <p>A description of each parameter follows:</p></ol>
 246
 247 <h5>image</h5>
 248 <ol><p>the image sequence.</p></ol>
 249
 250 <h5>stack</h5>
 251 <ol><p>A value other than 0 stacks the images top-to-bottom.</p></ol>
 252
 253 <h5>exception</h5>
 254 <ol><p>return any errors or warnings in this structure.</p></ol>
 255
 256  </div>
 257 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 258 _8c.html" target="source" name="CatchImageException">CatchImageException</a></h2>
 259 <div class="doc-section">
 260
 261 <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></ol>
 262
 263 <p>The format of the CatchImageException method is:</p>
 264
 265 <pre class="code">
 266   ExceptionType CatchImageException(Image *image)
 267 </pre>
 268
 269 <p>A description of each parameter follows:</p></ol>
 270
 271 <h5>image</h5>
 272 <ol><p>An image sequence.</p></ol>
 273
 274  </div>
 275 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 276 _8c.html" target="source" name="ClipImagePath">ClipImagePath</a></h2>
 277 <div class="doc-section">
 278
 279 <p>ClipImagePath() sets the image clip mask based any clipping path information if it exists.</p></ol>
 280
 281 <p>The format of the ClipImagePath method is:</p>
 282
 283 <pre class="code">
 284   MagickBooleanType ClipImagePath(Image *image,const char *pathname,
 285     const MagickBooleanType inside)
 286 </pre>
 287
 288 <p>A description of each parameter follows:</p></ol>
 289
 290 <h5>image</h5>
 291 <ol><p>the image.</p></ol>
 292
 293 <h5>pathname</h5>
 294 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
 295
 296 <h5>inside</h5>
 297 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
 298
 299  </div>
 300 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 301 _8c.html" target="source" name="CloneImage">CloneImage</a></h2>
 302 <div class="doc-section">
 303
 304 <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></ol>
 305
 306 <p>The format of the CloneImage method is:</p>
 307
 308 <pre class="code">
 309   Image *CloneImage(const Image *image,const unsigned long columns,
 310     const unsigned long rows,const MagickBooleanType orphan,
 311     ExceptionInfo *exception)
 312 </pre>
 313
 314 <p>A description of each parameter follows:</p></ol>
 315
 316 <h5>image</h5>
 317 <ol><p>the image.</p></ol>
 318
 319 <h5>columns</h5>
 320 <ol><p>the number of columns in the cloned image.</p></ol>
 321
 322 <h5>rows</h5>
 323 <ol><p>the number of rows in the cloned image.</p></ol>
 324
 325 <h5>detach</h5>
 326 <ol><p>With a value other than 0, the cloned image is detached from its parent I/O stream.</p></ol>
 327
 328 <h5>exception</h5>
 329 <ol><p>return any errors or warnings in this structure.</p></ol>
 330
 331  </div>
 332 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 333 _8c.html" target="source" name="CloneImageInfo">CloneImageInfo</a></h2>
 334 <div class="doc-section">
 335
 336 <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></ol>
 337
 338 <p>The format of the CloneImageInfo method is:</p>
 339
 340 <pre class="code">
 341   ImageInfo *CloneImageInfo(const ImageInfo *image_info)
 342 </pre>
 343
 344 <p>A description of each parameter follows:</p></ol>
 345
 346 <h5>image_info</h5>
 347 <ol><p>the image info.</p></ol>
 348
 349  </div>
 350 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 351 _8c.html" target="source" name="CombineImages">CombineImages</a></h2>
 352 <div class="doc-section">
 353
 354 <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></ol>
 355
 356 <p>The format of the CombineImages method is:</p>
 357
 358 <pre class="code">
 359   Image *CombineImages(const Image *image,const ChannelType channel,
 360     ExceptionInfo *exception)
 361 </pre>
 362
 363 <p>A description of each parameter follows:</p></ol>
 364
 365 <h5>image</h5>
 366 <ol><p>the image.</p></ol>
 367
 368 <h5>exception</h5>
 369 <ol><p>return any errors or warnings in this structure.</p></ol>
 370
 371  </div>
 372 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 373 _8c.html" target="source" name="DestroyImage">DestroyImage</a></h2>
 374 <div class="doc-section">
 375
 376 <p>DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p></ol>
 377
 378 <p>The format of the DestroyImage method is:</p>
 379
 380 <pre class="code">
 381   Image *DestroyImage(Image *image)
 382 </pre>
 383
 384 <p>A description of each parameter follows:</p></ol>
 385
 386 <h5>image</h5>
 387 <ol><p>the image.</p></ol>
 388
 389  </div>
 390 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 391 _8c.html" target="source" name="DestroyImageInfo">DestroyImageInfo</a></h2>
 392 <div class="doc-section">
 393
 394 <p>DestroyImageInfo() deallocates memory associated with an ImageInfo structure.</p></ol>
 395
 396 <p>The format of the DestroyImageInfo method is:</p>
 397
 398 <pre class="code">
 399   ImageInfo *DestroyImageInfo(ImageInfo *image_info)
 400 </pre>
 401
 402 <p>A description of each parameter follows:</p></ol>
 403
 404 <h5>image_info</h5>
 405 <ol><p>the image info.</p></ol>
 406
 407  </div>
 408 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 409 _8c.html" target="source" name="GetImageAlphaChannel">GetImageAlphaChannel</a></h2>
 410 <div class="doc-section">
 411
 412 <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></ol>
 413
 414 <p>The format of the GetImageAlphaChannel method is:</p>
 415
 416 <pre class="code">
 417   MagickBooleanType GetImageAlphaChannel(const Image *image)
 418 </pre>
 419
 420 <p>A description of each parameter follows:</p></ol>
 421
 422 <h5>image</h5>
 423 <ol><p>the image.</p></ol>
 424
 425  </div>
 426 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 427 _8c.html" target="source" name="GetImageClipMask">GetImageClipMask</a></h2>
 428 <div class="doc-section">
 429
 430 <p>GetImageClipMask() returns the clip path associated with the image.</p></ol>
 431
 432 <p>The format of the GetImageClipMask method is:</p>
 433
 434 <pre class="code">
 435   Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
 436 </pre>
 437
 438 <p>A description of each parameter follows:</p></ol>
 439
 440 <h5>image</h5>
 441 <ol><p>the image.</p></ol>
 442
 443  </div>
 444 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 445 _8c.html" target="source" name="GetImageException">GetImageException</a></h2>
 446 <div class="doc-section">
 447
 448 <p>GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.</p></ol>
 449
 450 <p>The format of the GetImageException method is:</p>
 451
 452 <pre class="code">
 453   void GetImageException(Image *image,ExceptionInfo *exception)
 454 </pre>
 455
 456 <p>A description of each parameter follows:</p></ol>
 457
 458 <h5>image</h5>
 459 <ol><p>Specifies a pointer to a list of one or more images.</p></ol>
 460
 461 <h5>exception</h5>
 462 <ol><p>return the highest severity exception.</p></ol>
 463
 464  </div>
 465 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 466 _8c.html" target="source" name="GetImageInfo">GetImageInfo</a></h2>
 467 <div class="doc-section">
 468
 469 <p>GetImageInfo() initializes image_info to default values.</p></ol>
 470
 471 <p>The format of the GetImageInfo method is:</p>
 472
 473 <pre class="code">
 474   void GetImageInfo(ImageInfo *image_info)
 475 </pre>
 476
 477 <p>A description of each parameter follows:</p></ol>
 478
 479 <h5>image_info</h5>
 480 <ol><p>the image info.</p></ol>
 481
 482  </div>
 483 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 484 _8c.html" target="source" name="GetImageMask">GetImageMask</a></h2>
 485 <div class="doc-section">
 486
 487 <p>GetImageMask() returns the mask associated with the image.</p></ol>
 488
 489 <p>The format of the GetImageMask method is:</p>
 490
 491 <pre class="code">
 492   Image *GetImageMask(const Image *image,ExceptionInfo *exception)
 493 </pre>
 494
 495 <p>A description of each parameter follows:</p></ol>
 496
 497 <h5>image</h5>
 498 <ol><p>the image.</p></ol>
 499
 500  </div>
 501 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 502 _8c.html" target="source" name="GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a></h2>
 503 <div class="doc-section">
 504
 505 <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></ol>
 506
 507 <p>The format of the GetImageVirtualPixelMethod() method is:</p>
 508
 509 <pre class="code">
 510   VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
 511 </pre>
 512
 513 <p>A description of each parameter follows:</p></ol>
 514
 515 <h5>image</h5>
 516 <ol><p>the image.</p></ol>
 517
 518  </div>
 519 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 520 _8c.html" target="source" name="InterpretImageFilename">InterpretImageFilename</a></h2>
 521 <div class="doc-section">
 522
 523 <p>InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.</p></ol>
 524
 525 <p>The format of the InterpretImageFilename method is:</p>
 526
 527 <pre class="code">
 528   size_t InterpretImageFilename(const ImageInfo *image_info,
 529     Image *image,const char *format,int value,char *filename)
 530 </pre>
 531
 532 <p>A description of each parameter follows.</p></ol>
 533
 534 <h5>image_info</h5>
 535 <ol><p>the image info..</p></ol>
 536
 537 <h5>image</h5>
 538 <ol><p>the image.</p></ol>
 539
 540 <h5>format</h5>
 541 <ol><p>A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.</p></ol>
 542
 543 <h5>value</h5>
 544 <ol><p>Numeric value to substitute into format filename.</p></ol>
 545
 546 <h5>filename</h5>
 547 <ol><p>return the formatted filename in this character buffer.</p></ol>
 548
 549  </div>
 550 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 551 _8c.html" target="source" name="IsHighDynamicRangeImage">IsHighDynamicRangeImage</a></h2>
 552 <div class="doc-section">
 553
 554 <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></ol>
 555
 556 <p>The format of the IsHighDynamicRangeImage method is:</p>
 557
 558 <pre class="code">
 559   MagickBooleanType IsHighDynamicRangeImage(const Image *image,
 560     ExceptionInfo *exception)
 561 </pre>
 562
 563 <p>A description of each parameter follows:</p></ol>
 564
 565 <h5>image</h5>
 566 <ol><p>the image.</p></ol>
 567
 568 <h5>exception</h5>
 569 <ol><p>return any errors or warnings in this structure.</p></ol>
 570
 571  </div>
 572 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 573 _8c.html" target="source" name="IsImageObject">IsImageObject</a></h2>
 574 <div class="doc-section">
 575
 576 <p>IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.</p></ol>
 577
 578 <p>The format of the IsImageObject method is:</p>
 579
 580 <pre class="code">
 581   MagickBooleanType IsImageObject(const Image *image)
 582 </pre>
 583
 584 <p>A description of each parameter follows:</p></ol>
 585
 586 <h5>image</h5>
 587 <ol><p>the image.</p></ol>
 588
 589  </div>
 590 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 591 _8c.html" target="source" name="IsTaintImage">IsTaintImage</a></h2>
 592 <div class="doc-section">
 593
 594 <p>IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.</p></ol>
 595
 596 <p>The format of the IsTaintImage method is:</p>
 597
 598 <pre class="code">
 599   MagickBooleanType IsTaintImage(const Image *image)
 600 </pre>
 601
 602 <p>A description of each parameter follows:</p></ol>
 603
 604 <h5>image</h5>
 605 <ol><p>the image.</p></ol>
 606
 607  </div>
 608 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 609 _8c.html" target="source" name="ModifyImage">ModifyImage</a></h2>
 610 <div class="doc-section">
 611
 612 <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></ol>
 613
 614 <p>The format of the ModifyImage method is:</p>
 615
 616 <pre class="code">
 617   MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
 618 </pre>
 619
 620 <p>A description of each parameter follows:</p></ol>
 621
 622 <h5>image</h5>
 623 <ol><p>the image.</p></ol>
 624
 625 <h5>exception</h5>
 626 <ol><p>return any errors or warnings in this structure.</p></ol>
 627
 628  </div>
 629 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 630 _8c.html" target="source" name="NewMagickImage">NewMagickImage</a></h2>
 631 <div class="doc-section">
 632
 633 <p>NewMagickImage() creates a blank image canvas of the specified size and background color.</p></ol>
 634
 635 <p>The format of the NewMagickImage method is:</p>
 636
 637 <pre class="code">
 638   Image *NewMagickImage(const ImageInfo *image_info,
 639     const unsigned long width,const unsigned long height,
 640     const MagickPixelPacket *background)
 641 </pre>
 642
 643 <p>A description of each parameter follows:</p></ol>
 644
 645 <h5>image</h5>
 646 <ol><p>the image.</p></ol>
 647
 648 <h5>width</h5>
 649 <ol><p>the image width.</p></ol>
 650
 651 <h5>height</h5>
 652 <ol><p>the image height.</p></ol>
 653
 654 <h5>background</h5>
 655 <ol><p>the image color.</p></ol>
 656
 657  </div>
 658 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 659 _8c.html" target="source" name="ReferenceImage">ReferenceImage</a></h2>
 660 <div class="doc-section">
 661
 662 <p>ReferenceImage() increments the reference count associated with an image returning a pointer to the image.</p></ol>
 663
 664 <p>The format of the ReferenceImage method is:</p>
 665
 666 <pre class="code">
 667   Image *ReferenceImage(Image *image)
 668 </pre>
 669
 670 <p>A description of each parameter follows:</p></ol>
 671
 672 <h5>image</h5>
 673 <ol><p>the image.</p></ol>
 674
 675  </div>
 676 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 677 _8c.html" target="source" name="ResetImagePage">ResetImagePage</a></h2>
 678 <div class="doc-section">
 679
 680 <p>ResetImagePage() resets the image page canvas and position.</p></ol>
 681
 682 <p>The format of the ResetImagePage method is:</p>
 683
 684 <pre class="code">
 685   MagickBooleanType ResetImagePage(Image *image,const char *page)
 686 </pre>
 687
 688 <p>A description of each parameter follows:</p></ol>
 689
 690 <h5>image</h5>
 691 <ol><p>the image.</p></ol>
 692
 693 <h5>page</h5>
 694 <ol><p>the relative page specification.</p></ol>
 695
 696  </div>
 697 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 698 _8c.html" target="source" name="SeparateImageChannel">SeparateImageChannel</a></h2>
 699 <div class="doc-section">
 700
 701 <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></ol>
 702
 703 <p>The format of the SeparateImageChannel method is:</p>
 704
 705 <pre class="code">
 706   MagickBooleanType SeparateImageChannel(Image *image,
 707     const ChannelType channel)
 708 </pre>
 709
 710 <p>A description of each parameter follows:</p></ol>
 711
 712 <h5>image</h5>
 713 <ol><p>the image.</p></ol>
 714
 715 <h5>channel</h5>
 716 <ol><p>Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
 717
 718  </div>
 719 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 720 _8c.html" target="source" name="SeparateImages">SeparateImages</a></h2>
 721 <div class="doc-section">
 722
 723 <p>SeparateImages() returns a separate grayscale image for each channel specified.</p></ol>
 724
 725 <p>The format of the SeparateImages method is:</p>
 726
 727 <pre class="code">
 728   MagickBooleanType SeparateImages(const Image *image,
 729     const ChannelType channel,ExceptionInfo *exception)
 730 </pre>
 731
 732 <p>A description of each parameter follows:</p></ol>
 733
 734 <h5>image</h5>
 735 <ol><p>the image.</p></ol>
 736
 737 <h5>channel</h5>
 738 <ol><p>Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
 739
 740 <h5>exception</h5>
 741 <ol><p>return any errors or warnings in this structure.</p></ol>
 742
 743  </div>
 744 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 745 _8c.html" target="source" name="SetImageAlphaChannel">SetImageAlphaChannel</a></h2>
 746 <div class="doc-section">
 747
 748 <p>SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p></ol>
 749
 750 <p>The format of the SetImageAlphaChannel method is:</p>
 751
 752 <pre class="code">
 753   MagickBooleanType SetImageAlphaChannel(Image *image,
 754     const AlphaChannelType alpha_type)
 755 </pre>
 756
 757 <p>A description of each parameter follows:</p></ol>
 758
 759 <h5>image</h5>
 760 <ol><p>the image.</p></ol>
 761
 762 <h5>alpha_type</h5>
 763 <ol><p>The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.</p></ol>
 764
 765  </div>
 766 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 767 _8c.html" target="source" name="SetImageBackgroundColor">SetImageBackgroundColor</a></h2>
 768 <div class="doc-section">
 769
 770 <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></ol>
 771
 772 <p>The format of the SetImage method is:</p>
 773
 774 <pre class="code">
 775   MagickBooleanType SetImageBackgroundColor(Image *image)
 776 </pre>
 777
 778 <p>A description of each parameter follows:</p></ol>
 779
 780 <h5>image</h5>
 781 <ol><p>the image.</p></ol>
 782
 783  </div>
 784 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 785 _8c.html" target="source" name="SetImageStorageClass">SetImageStorageClass</a></h2>
 786 <div class="doc-section">
 787
 788 <p>SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.</p></ol>
 789
 790 <p>The format of the SetImageStorageClass method is:</p>
 791
 792 <pre class="code">
 793   MagickBooleanType SetImageStorageClass(Image *image,
 794     const ClassType storage_class)
 795 </pre>
 796
 797 <p>A description of each parameter follows:</p></ol>
 798
 799 <h5>image</h5>
 800 <ol><p>the image.</p></ol>
 801
 802 <h5>storage_class</h5>
 803 <ol><p>The image class.</p></ol>
 804
 805  </div>
 806 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 807 _8c.html" target="source" name="SetImageClipMask">SetImageClipMask</a></h2>
 808 <div class="doc-section">
 809
 810 <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></ol>
 811
 812 <p>The format of the SetImageClipMask method is:</p>
 813
 814 <pre class="code">
 815   MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
 816 </pre>
 817
 818 <p>A description of each parameter follows:</p></ol>
 819
 820 <h5>image</h5>
 821 <ol><p>the image.</p></ol>
 822
 823 <h5>clip_mask</h5>
 824 <ol><p>the image clip path.</p></ol>
 825
 826  </div>
 827 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 828 _8c.html" target="source" name="SetImageExtent">SetImageExtent</a></h2>
 829 <div class="doc-section">
 830
 831 <p>SetImageExtent() sets the image size (i.e. columns & rows).</p></ol>
 832
 833 <p>The format of the SetImageExtent method is:</p>
 834
 835 <pre class="code">
 836   MagickBooleanType SetImageExtent(Image *image,
 837     const unsigned long columns,const unsigned long rows)
 838 </pre>
 839
 840 <p>A description of each parameter follows:</p></ol>
 841
 842 <h5>image</h5>
 843 <ol><p>the image.</p></ol>
 844
 845 <h5>columns</h5>
 846 <ol><p>The image width in pixels.</p></ol>
 847
 848 <h5>rows</h5>
 849 <ol><p>The image height in pixels.</p></ol>
 850
 851  </div>
 852 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 853 _8c.html" target="source" name="SetImageInfoBlob">SetImageInfoBlob</a></h2>
 854 <div class="doc-section">
 855
 856 <p>SetImageInfoBlob() sets the image info blob member.</p></ol>
 857
 858 <p>The format of the SetImageInfoBlob method is:</p>
 859
 860 <pre class="code">
 861   void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
 862     const size_t length)
 863 </pre>
 864
 865 <p>A description of each parameter follows:</p></ol>
 866
 867 <h5>image_info</h5>
 868 <ol><p>the image info.</p></ol>
 869
 870 <h5>blob</h5>
 871 <ol><p>the blob.</p></ol>
 872
 873 <h5>length</h5>
 874 <ol><p>the blob length.</p></ol>
 875
 876  </div>
 877 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 878 _8c.html" target="source" name="SetImageInfoFile">SetImageInfoFile</a></h2>
 879 <div class="doc-section">
 880
 881 <p>SetImageInfoFile() sets the image info file member.</p></ol>
 882
 883 <p>The format of the SetImageInfoFile method is:</p>
 884
 885 <pre class="code">
 886   void SetImageInfoFile(ImageInfo *image_info,FILE *file)
 887 </pre>
 888
 889 <p>A description of each parameter follows:</p></ol>
 890
 891 <h5>image_info</h5>
 892 <ol><p>the image info.</p></ol>
 893
 894 <h5>file</h5>
 895 <ol><p>the file.</p></ol>
 896
 897  </div>
 898 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 899 _8c.html" target="source" name="SetImageMask">SetImageMask</a></h2>
 900 <div class="doc-section">
 901
 902 <p>SetImageMask() associates a mask with the image.  The mask must be the same dimensions as the image.</p></ol>
 903
 904 <p>The format of the SetImageMask method is:</p>
 905
 906 <pre class="code">
 907   MagickBooleanType SetImageMask(Image *image,const Image *mask)
 908 </pre>
 909
 910 <p>A description of each parameter follows:</p></ol>
 911
 912 <h5>image</h5>
 913 <ol><p>the image.</p></ol>
 914
 915 <h5>mask</h5>
 916 <ol><p>the image mask.</p></ol>
 917
 918  </div>
 919 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 920 _8c.html" target="source" name="SetImageOpacity">SetImageOpacity</a></h2>
 921 <div class="doc-section">
 922
 923 <p>SetImageOpacity() sets the opacity levels of the image.</p></ol>
 924
 925 <p>The format of the SetImageOpacity method is:</p>
 926
 927 <pre class="code">
 928   MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
 929 </pre>
 930
 931 <p>A description of each parameter follows:</p></ol>
 932
 933 <h5>image</h5>
 934 <ol><p>the image.</p></ol>
 935
 936 <h5>opacity</h5>
 937 <ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
 938
 939  </div>
 940 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 941 _8c.html" target="source" name="SetImageType">SetImageType</a></h2>
 942 <div class="doc-section">
 943
 944 <p>SetImageType() sets the type of image.  Choose from these types:</p></ol>
 945
 946 <p>Bilevel        Grayscale       GrayscaleMatte Palette        PaletteMatte    TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte OptimizeType</p></ol>
 947
 948 <p>The format of the SetImageType method is:</p>
 949
 950 <pre class="code">
 951   MagickBooleanType SetImageType(Image *image,const ImageType type)
 952 </pre>
 953
 954 <p>A description of each parameter follows:</p></ol>
 955
 956 <h5>image</h5>
 957 <ol><p>the image.</p></ol>
 958
 959 <h5>type</h5>
 960 <ol><p>Image type.</p></ol>
 961
 962  </div>
 963 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 964 _8c.html" target="source" name="SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a></h2>
 965 <div class="doc-section">
 966
 967 <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></ol>
 968
 969 <p>The format of the SetImageVirtualPixelMethod() method is:</p>
 970
 971 <pre class="code">
 972   VirtualPixelMethod SetImageVirtualPixelMethod(const Image *image,
 973     const VirtualPixelMethod virtual_pixel_method)
 974 </pre>
 975
 976 <p>A description of each parameter follows:</p></ol>
 977
 978 <h5>image</h5>
 979 <ol><p>the image.</p></ol>
 980
 981 <h5>virtual_pixel_method</h5>
 982 <ol><p>choose the type of virtual pixel.</p></ol>
 983
 984  </div>
 985 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 986 _8c.html" target="source" name="StripImage">StripImage</a></h2>
 987 <div class="doc-section">
 988
 989 <p>StripImage() strips an image of all profiles and comments.</p></ol>
 990
 991 <p>The format of the StripImage method is:</p>
 992
 993 <pre class="code">
 994   MagickBooleanType StripImage(Image *image)
 995 </pre>
 996
 997 <p>A description of each parameter follows:</p></ol>
 998
 999 <h5>image</h5>
1000 <ol><p>the image.</p></ol>
1001
1002  </div>
1003 \r
1004 </div>\r
1005 \r
1006 <div id="linkbar">\r
1007  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
1008     <span id="linkbar-center">\r
1009       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
1010       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
1011     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
1012     </span>\r
1013     <span id="linkbar-east">&nbsp;</span>\r
1014   </div>\r
1015   <div class="footer">\r
1016     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
1017     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
1018   </div>\r
1019   <div style="clear: both; margin: 0; width: 100%; "></div>\r
1020 </body>\r
1021 </html>\r