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.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 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.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 142 </div>
 143 </div>
 144 </div>
 145 \r
 146 \r
 147 </div>\r
 148 \r
 149 <div class="main">\r
 150 \r
 151 <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> &bull; <a href="#SyncImageSettings">SyncImageSettings</a>]</p>
 152
 153 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 154 _8c.html" target="source" name="AcquireImage">AcquireImage</a></h2>
 155 <div class="doc-section">
 156
 157 <p>AcquireImage() returns a pointer to an image structure initialized to default values.</p></ol>
 158
 159 <p>The format of the AcquireImage method is:</p>
 160
 161 <pre class="code">
 162   Image *AcquireImage(const ImageInfo *image_info)
 163 </pre>
 164
 165 <p>A description of each parameter follows:</p></ol>
 166
 167 <h5>image_info</h5>
 168 <ol><p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p></ol>
 169
 170  </div>
 171 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 172 _8c.html" target="source" name="AcquireImageColormap">AcquireImageColormap</a></h2>
 173 <div class="doc-section">
 174
 175 <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>
 176
 177 <p>The format of the AcquireImageColormap method is:</p>
 178
 179 <pre class="code">
 180   MagickBooleanType AcquireImageColormap(Image *image,
 181     const unsigned long colors)
 182 </pre>
 183
 184 <p>A description of each parameter follows:</p></ol>
 185
 186 <h5>image</h5>
 187 <ol><p>the image.</p></ol>
 188
 189 <h5>colors</h5>
 190 <ol><p>the number of colors in the image colormap.</p></ol>
 191
 192  </div>
 193 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 194 _8c.html" target="source" name="AcquireImageInfo">AcquireImageInfo</a></h2>
 195 <div class="doc-section">
 196
 197 <p>AcquireImageInfo() allocates the ImageInfo structure.</p></ol>
 198
 199 <p>The format of the AcquireImageInfo method is:</p>
 200
 201 <pre class="code">
 202   ImageInfo *AcquireImageInfo(void)
 203 </pre>
 204
 205  </div>
 206 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 207 _8c.html" target="source" name="AcquireNextImage">AcquireNextImage</a></h2>
 208 <div class="doc-section">
 209
 210 <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>
 211
 212 <p>The format of the AcquireNextImage method is:</p>
 213
 214 <pre class="code">
 215   void AcquireNextImage(const ImageInfo *image_info,Image *image)
 216 </pre>
 217
 218 <p>A description of each parameter follows:</p></ol>
 219
 220 <h5>image_info</h5>
 221 <ol><p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p></ol>
 222
 223 <h5>image</h5>
 224 <ol><p>the image.</p></ol>
 225
 226  </div>
 227 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 228 _8c.html" target="source" name="AppendImages">AppendImages</a></h2>
 229 <div class="doc-section">
 230
 231 <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>
 232
 233 <p>The current gravity setting now effects how the image is justified in the final image.</p></ol>
 234
 235 <p>The format of the AppendImages method is:</p>
 236
 237 <pre class="code">
 238   Image *AppendImages(const Image *image,const MagickBooleanType stack,
 239     ExceptionInfo *exception)
 240 </pre>
 241
 242 <p>A description of each parameter follows:</p></ol>
 243
 244 <h5>image</h5>
 245 <ol><p>the image sequence.</p></ol>
 246
 247 <h5>stack</h5>
 248 <ol><p>A value other than 0 stacks the images top-to-bottom.</p></ol>
 249
 250 <h5>exception</h5>
 251 <ol><p>return any errors or warnings in this structure.</p></ol>
 252
 253  </div>
 254 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 255 _8c.html" target="source" name="CatchImageException">CatchImageException</a></h2>
 256 <div class="doc-section">
 257
 258 <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>
 259
 260 <p>The format of the CatchImageException method is:</p>
 261
 262 <pre class="code">
 263   ExceptionType CatchImageException(Image *image)
 264 </pre>
 265
 266 <p>A description of each parameter follows:</p></ol>
 267
 268 <h5>image</h5>
 269 <ol><p>An image sequence.</p></ol>
 270
 271  </div>
 272 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 273 _8c.html" target="source" name="ClipImagePath">ClipImagePath</a></h2>
 274 <div class="doc-section">
 275
 276 <p>ClipImagePath() sets the image clip mask based any clipping path information if it exists.</p></ol>
 277
 278 <p>The format of the ClipImagePath method is:</p>
 279
 280 <pre class="code">
 281   MagickBooleanType ClipImagePath(Image *image,const char *pathname,
 282     const MagickBooleanType inside)
 283 </pre>
 284
 285 <p>A description of each parameter follows:</p></ol>
 286
 287 <h5>image</h5>
 288 <ol><p>the image.</p></ol>
 289
 290 <h5>pathname</h5>
 291 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
 292
 293 <h5>inside</h5>
 294 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
 295
 296  </div>
 297 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 298 _8c.html" target="source" name="CloneImage">CloneImage</a></h2>
 299 <div class="doc-section">
 300
 301 <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>
 302
 303 <p>The format of the CloneImage method is:</p>
 304
 305 <pre class="code">
 306   Image *CloneImage(const Image *image,const unsigned long columns,
 307     const unsigned long rows,const MagickBooleanType orphan,
 308     ExceptionInfo *exception)
 309 </pre>
 310
 311 <p>A description of each parameter follows:</p></ol>
 312
 313 <h5>image</h5>
 314 <ol><p>the image.</p></ol>
 315
 316 <h5>columns</h5>
 317 <ol><p>the number of columns in the cloned image.</p></ol>
 318
 319 <h5>rows</h5>
 320 <ol><p>the number of rows in the cloned image.</p></ol>
 321
 322 <h5>detach</h5>
 323 <ol><p>With a value other than 0, the cloned image is detached from its parent I/O stream.</p></ol>
 324
 325 <h5>exception</h5>
 326 <ol><p>return any errors or warnings in this structure.</p></ol>
 327
 328  </div>
 329 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 330 _8c.html" target="source" name="CloneImageInfo">CloneImageInfo</a></h2>
 331 <div class="doc-section">
 332
 333 <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>
 334
 335 <p>The format of the CloneImageInfo method is:</p>
 336
 337 <pre class="code">
 338   ImageInfo *CloneImageInfo(const ImageInfo *image_info)
 339 </pre>
 340
 341 <p>A description of each parameter follows:</p></ol>
 342
 343 <h5>image_info</h5>
 344 <ol><p>the image info.</p></ol>
 345
 346  </div>
 347 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 348 _8c.html" target="source" name="CombineImages">CombineImages</a></h2>
 349 <div class="doc-section">
 350
 351 <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>
 352
 353 <p>The format of the CombineImages method is:</p>
 354
 355 <pre class="code">
 356   Image *CombineImages(const Image *image,const ChannelType channel,
 357     ExceptionInfo *exception)
 358 </pre>
 359
 360 <p>A description of each parameter follows:</p></ol>
 361
 362 <h5>image</h5>
 363 <ol><p>the image.</p></ol>
 364
 365 <h5>exception</h5>
 366 <ol><p>return any errors or warnings in this structure.</p></ol>
 367
 368  </div>
 369 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 370 _8c.html" target="source" name="DestroyImage">DestroyImage</a></h2>
 371 <div class="doc-section">
 372
 373 <p>DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.</p></ol>
 374
 375 <p>The format of the DestroyImage method is:</p>
 376
 377 <pre class="code">
 378   Image *DestroyImage(Image *image)
 379 </pre>
 380
 381 <p>A description of each parameter follows:</p></ol>
 382
 383 <h5>image</h5>
 384 <ol><p>the image.</p></ol>
 385
 386  </div>
 387 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 388 _8c.html" target="source" name="DestroyImageInfo">DestroyImageInfo</a></h2>
 389 <div class="doc-section">
 390
 391 <p>DestroyImageInfo() deallocates memory associated with an ImageInfo structure.</p></ol>
 392
 393 <p>The format of the DestroyImageInfo method is:</p>
 394
 395 <pre class="code">
 396   ImageInfo *DestroyImageInfo(ImageInfo *image_info)
 397 </pre>
 398
 399 <p>A description of each parameter follows:</p></ol>
 400
 401 <h5>image_info</h5>
 402 <ol><p>the image info.</p></ol>
 403
 404  </div>
 405 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 406 _8c.html" target="source" name="GetImageAlphaChannel">GetImageAlphaChannel</a></h2>
 407 <div class="doc-section">
 408
 409 <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>
 410
 411 <p>The format of the GetImageAlphaChannel method is:</p>
 412
 413 <pre class="code">
 414   MagickBooleanType GetImageAlphaChannel(const Image *image)
 415 </pre>
 416
 417 <p>A description of each parameter follows:</p></ol>
 418
 419 <h5>image</h5>
 420 <ol><p>the image.</p></ol>
 421
 422  </div>
 423 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 424 _8c.html" target="source" name="GetImageClipMask">GetImageClipMask</a></h2>
 425 <div class="doc-section">
 426
 427 <p>GetImageClipMask() returns the clip path associated with the image.</p></ol>
 428
 429 <p>The format of the GetImageClipMask method is:</p>
 430
 431 <pre class="code">
 432   Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
 433 </pre>
 434
 435 <p>A description of each parameter follows:</p></ol>
 436
 437 <h5>image</h5>
 438 <ol><p>the image.</p></ol>
 439
 440  </div>
 441 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 442 _8c.html" target="source" name="GetImageException">GetImageException</a></h2>
 443 <div class="doc-section">
 444
 445 <p>GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.</p></ol>
 446
 447 <p>The format of the GetImageException method is:</p>
 448
 449 <pre class="code">
 450   void GetImageException(Image *image,ExceptionInfo *exception)
 451 </pre>
 452
 453 <p>A description of each parameter follows:</p></ol>
 454
 455 <h5>image</h5>
 456 <ol><p>Specifies a pointer to a list of one or more images.</p></ol>
 457
 458 <h5>exception</h5>
 459 <ol><p>return the highest severity exception.</p></ol>
 460
 461  </div>
 462 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 463 _8c.html" target="source" name="GetImageInfo">GetImageInfo</a></h2>
 464 <div class="doc-section">
 465
 466 <p>GetImageInfo() initializes image_info to default values.</p></ol>
 467
 468 <p>The format of the GetImageInfo method is:</p>
 469
 470 <pre class="code">
 471   void GetImageInfo(ImageInfo *image_info)
 472 </pre>
 473
 474 <p>A description of each parameter follows:</p></ol>
 475
 476 <h5>image_info</h5>
 477 <ol><p>the image info.</p></ol>
 478
 479  </div>
 480 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 481 _8c.html" target="source" name="GetImageMask">GetImageMask</a></h2>
 482 <div class="doc-section">
 483
 484 <p>GetImageMask() returns the mask associated with the image.</p></ol>
 485
 486 <p>The format of the GetImageMask method is:</p>
 487
 488 <pre class="code">
 489   Image *GetImageMask(const Image *image,ExceptionInfo *exception)
 490 </pre>
 491
 492 <p>A description of each parameter follows:</p></ol>
 493
 494 <h5>image</h5>
 495 <ol><p>the image.</p></ol>
 496
 497  </div>
 498 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 499 _8c.html" target="source" name="GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a></h2>
 500 <div class="doc-section">
 501
 502 <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>
 503
 504 <p>The format of the GetImageVirtualPixelMethod() method is:</p>
 505
 506 <pre class="code">
 507   VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
 508 </pre>
 509
 510 <p>A description of each parameter follows:</p></ol>
 511
 512 <h5>image</h5>
 513 <ol><p>the image.</p></ol>
 514
 515  </div>
 516 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 517 _8c.html" target="source" name="InterpretImageFilename">InterpretImageFilename</a></h2>
 518 <div class="doc-section">
 519
 520 <p>InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.</p></ol>
 521
 522 <p>The format of the InterpretImageFilename method is:</p>
 523
 524 <pre class="code">
 525   size_t InterpretImageFilename(const ImageInfo *image_info,
 526     Image *image,const char *format,int value,char *filename)
 527 </pre>
 528
 529 <p>A description of each parameter follows.</p></ol>
 530
 531 <h5>image_info</h5>
 532 <ol><p>the image info..</p></ol>
 533
 534 <h5>image</h5>
 535 <ol><p>the image.</p></ol>
 536
 537 <h5>format</h5>
 538 <ol><p>A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.</p></ol>
 539
 540 <h5>value</h5>
 541 <ol><p>Numeric value to substitute into format filename.</p></ol>
 542
 543 <h5>filename</h5>
 544 <ol><p>return the formatted filename in this character buffer.</p></ol>
 545
 546  </div>
 547 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 548 _8c.html" target="source" name="IsHighDynamicRangeImage">IsHighDynamicRangeImage</a></h2>
 549 <div class="doc-section">
 550
 551 <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>
 552
 553 <p>The format of the IsHighDynamicRangeImage method is:</p>
 554
 555 <pre class="code">
 556   MagickBooleanType IsHighDynamicRangeImage(const Image *image,
 557     ExceptionInfo *exception)
 558 </pre>
 559
 560 <p>A description of each parameter follows:</p></ol>
 561
 562 <h5>image</h5>
 563 <ol><p>the image.</p></ol>
 564
 565 <h5>exception</h5>
 566 <ol><p>return any errors or warnings in this structure.</p></ol>
 567
 568  </div>
 569 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 570 _8c.html" target="source" name="IsImageObject">IsImageObject</a></h2>
 571 <div class="doc-section">
 572
 573 <p>IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.</p></ol>
 574
 575 <p>The format of the IsImageObject method is:</p>
 576
 577 <pre class="code">
 578   MagickBooleanType IsImageObject(const Image *image)
 579 </pre>
 580
 581 <p>A description of each parameter follows:</p></ol>
 582
 583 <h5>image</h5>
 584 <ol><p>the image.</p></ol>
 585
 586  </div>
 587 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 588 _8c.html" target="source" name="IsTaintImage">IsTaintImage</a></h2>
 589 <div class="doc-section">
 590
 591 <p>IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.</p></ol>
 592
 593 <p>The format of the IsTaintImage method is:</p>
 594
 595 <pre class="code">
 596   MagickBooleanType IsTaintImage(const Image *image)
 597 </pre>
 598
 599 <p>A description of each parameter follows:</p></ol>
 600
 601 <h5>image</h5>
 602 <ol><p>the image.</p></ol>
 603
 604  </div>
 605 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 606 _8c.html" target="source" name="ModifyImage">ModifyImage</a></h2>
 607 <div class="doc-section">
 608
 609 <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>
 610
 611 <p>The format of the ModifyImage method is:</p>
 612
 613 <pre class="code">
 614   MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
 615 </pre>
 616
 617 <p>A description of each parameter follows:</p></ol>
 618
 619 <h5>image</h5>
 620 <ol><p>the image.</p></ol>
 621
 622 <h5>exception</h5>
 623 <ol><p>return any errors or warnings in this structure.</p></ol>
 624
 625  </div>
 626 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 627 _8c.html" target="source" name="NewMagickImage">NewMagickImage</a></h2>
 628 <div class="doc-section">
 629
 630 <p>NewMagickImage() creates a blank image canvas of the specified size and background color.</p></ol>
 631
 632 <p>The format of the NewMagickImage method is:</p>
 633
 634 <pre class="code">
 635   Image *NewMagickImage(const ImageInfo *image_info,
 636     const unsigned long width,const unsigned long height,
 637     const MagickPixelPacket *background)
 638 </pre>
 639
 640 <p>A description of each parameter follows:</p></ol>
 641
 642 <h5>image</h5>
 643 <ol><p>the image.</p></ol>
 644
 645 <h5>width</h5>
 646 <ol><p>the image width.</p></ol>
 647
 648 <h5>height</h5>
 649 <ol><p>the image height.</p></ol>
 650
 651 <h5>background</h5>
 652 <ol><p>the image color.</p></ol>
 653
 654  </div>
 655 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 656 _8c.html" target="source" name="ReferenceImage">ReferenceImage</a></h2>
 657 <div class="doc-section">
 658
 659 <p>ReferenceImage() increments the reference count associated with an image returning a pointer to the image.</p></ol>
 660
 661 <p>The format of the ReferenceImage method is:</p>
 662
 663 <pre class="code">
 664   Image *ReferenceImage(Image *image)
 665 </pre>
 666
 667 <p>A description of each parameter follows:</p></ol>
 668
 669 <h5>image</h5>
 670 <ol><p>the image.</p></ol>
 671
 672  </div>
 673 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 674 _8c.html" target="source" name="ResetImagePage">ResetImagePage</a></h2>
 675 <div class="doc-section">
 676
 677 <p>ResetImagePage() resets the image page canvas and position.</p></ol>
 678
 679 <p>The format of the ResetImagePage method is:</p>
 680
 681 <pre class="code">
 682   MagickBooleanType ResetImagePage(Image *image,const char *page)
 683 </pre>
 684
 685 <p>A description of each parameter follows:</p></ol>
 686
 687 <h5>image</h5>
 688 <ol><p>the image.</p></ol>
 689
 690 <h5>page</h5>
 691 <ol><p>the relative page specification.</p></ol>
 692
 693  </div>
 694 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 695 _8c.html" target="source" name="SeparateImageChannel">SeparateImageChannel</a></h2>
 696 <div class="doc-section">
 697
 698 <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>
 699
 700 <p>The format of the SeparateImageChannel method is:</p>
 701
 702 <pre class="code">
 703   MagickBooleanType SeparateImageChannel(Image *image,
 704     const ChannelType channel)
 705 </pre>
 706
 707 <p>A description of each parameter follows:</p></ol>
 708
 709 <h5>image</h5>
 710 <ol><p>the image.</p></ol>
 711
 712 <h5>channel</h5>
 713 <ol><p>Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
 714
 715  </div>
 716 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 717 _8c.html" target="source" name="SeparateImages">SeparateImages</a></h2>
 718 <div class="doc-section">
 719
 720 <p>SeparateImages() returns a separate grayscale image for each channel specified.</p></ol>
 721
 722 <p>The format of the SeparateImages method is:</p>
 723
 724 <pre class="code">
 725   MagickBooleanType SeparateImages(const Image *image,
 726     const ChannelType channel,ExceptionInfo *exception)
 727 </pre>
 728
 729 <p>A description of each parameter follows:</p></ol>
 730
 731 <h5>image</h5>
 732 <ol><p>the image.</p></ol>
 733
 734 <h5>channel</h5>
 735 <ol><p>Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.</p></ol>
 736
 737 <h5>exception</h5>
 738 <ol><p>return any errors or warnings in this structure.</p></ol>
 739
 740  </div>
 741 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 742 _8c.html" target="source" name="SetImageAlphaChannel">SetImageAlphaChannel</a></h2>
 743 <div class="doc-section">
 744
 745 <p>SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.</p></ol>
 746
 747 <p>The format of the SetImageAlphaChannel method is:</p>
 748
 749 <pre class="code">
 750   MagickBooleanType SetImageAlphaChannel(Image *image,
 751     const AlphaChannelType alpha_type)
 752 </pre>
 753
 754 <p>A description of each parameter follows:</p></ol>
 755
 756 <h5>image</h5>
 757 <ol><p>the image.</p></ol>
 758
 759 <h5>alpha_type</h5>
 760 <ol><p>The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.</p></ol>
 761
 762  </div>
 763 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 764 _8c.html" target="source" name="SetImageBackgroundColor">SetImageBackgroundColor</a></h2>
 765 <div class="doc-section">
 766
 767 <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>
 768
 769 <p>The format of the SetImage method is:</p>
 770
 771 <pre class="code">
 772   MagickBooleanType SetImageBackgroundColor(Image *image)
 773 </pre>
 774
 775 <p>A description of each parameter follows:</p></ol>
 776
 777 <h5>image</h5>
 778 <ol><p>the image.</p></ol>
 779
 780  </div>
 781 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 782 _8c.html" target="source" name="SetImageStorageClass">SetImageStorageClass</a></h2>
 783 <div class="doc-section">
 784
 785 <p>SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.</p></ol>
 786
 787 <p>The format of the SetImageStorageClass method is:</p>
 788
 789 <pre class="code">
 790   MagickBooleanType SetImageStorageClass(Image *image,
 791     const ClassType storage_class)
 792 </pre>
 793
 794 <p>A description of each parameter follows:</p></ol>
 795
 796 <h5>image</h5>
 797 <ol><p>the image.</p></ol>
 798
 799 <h5>storage_class</h5>
 800 <ol><p>The image class.</p></ol>
 801
 802  </div>
 803 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 804 _8c.html" target="source" name="SetImageClipMask">SetImageClipMask</a></h2>
 805 <div class="doc-section">
 806
 807 <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>
 808
 809 <p>The format of the SetImageClipMask method is:</p>
 810
 811 <pre class="code">
 812   MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
 813 </pre>
 814
 815 <p>A description of each parameter follows:</p></ol>
 816
 817 <h5>image</h5>
 818 <ol><p>the image.</p></ol>
 819
 820 <h5>clip_mask</h5>
 821 <ol><p>the image clip path.</p></ol>
 822
 823  </div>
 824 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 825 _8c.html" target="source" name="SetImageExtent">SetImageExtent</a></h2>
 826 <div class="doc-section">
 827
 828 <p>SetImageExtent() sets the image size (i.e. columns & rows).</p></ol>
 829
 830 <p>The format of the SetImageExtent method is:</p>
 831
 832 <pre class="code">
 833   MagickBooleanType SetImageExtent(Image *image,
 834     const unsigned long columns,const unsigned long rows)
 835 </pre>
 836
 837 <p>A description of each parameter follows:</p></ol>
 838
 839 <h5>image</h5>
 840 <ol><p>the image.</p></ol>
 841
 842 <h5>columns</h5>
 843 <ol><p>The image width in pixels.</p></ol>
 844
 845 <h5>rows</h5>
 846 <ol><p>The image height in pixels.</p></ol>
 847
 848  </div>
 849 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 850 _8c.html" target="source" name="SetImageInfoBlob">SetImageInfoBlob</a></h2>
 851 <div class="doc-section">
 852
 853 <p>SetImageInfoBlob() sets the image info blob member.</p></ol>
 854
 855 <p>The format of the SetImageInfoBlob method is:</p>
 856
 857 <pre class="code">
 858   void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
 859     const size_t length)
 860 </pre>
 861
 862 <p>A description of each parameter follows:</p></ol>
 863
 864 <h5>image_info</h5>
 865 <ol><p>the image info.</p></ol>
 866
 867 <h5>blob</h5>
 868 <ol><p>the blob.</p></ol>
 869
 870 <h5>length</h5>
 871 <ol><p>the blob length.</p></ol>
 872
 873  </div>
 874 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 875 _8c.html" target="source" name="SetImageInfoFile">SetImageInfoFile</a></h2>
 876 <div class="doc-section">
 877
 878 <p>SetImageInfoFile() sets the image info file member.</p></ol>
 879
 880 <p>The format of the SetImageInfoFile method is:</p>
 881
 882 <pre class="code">
 883   void SetImageInfoFile(ImageInfo *image_info,FILE *file)
 884 </pre>
 885
 886 <p>A description of each parameter follows:</p></ol>
 887
 888 <h5>image_info</h5>
 889 <ol><p>the image info.</p></ol>
 890
 891 <h5>file</h5>
 892 <ol><p>the file.</p></ol>
 893
 894  </div>
 895 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 896 _8c.html" target="source" name="SetImageMask">SetImageMask</a></h2>
 897 <div class="doc-section">
 898
 899 <p>SetImageMask() associates a mask with the image.  The mask must be the same dimensions as the image.</p></ol>
 900
 901 <p>The format of the SetImageMask method is:</p>
 902
 903 <pre class="code">
 904   MagickBooleanType SetImageMask(Image *image,const Image *mask)
 905 </pre>
 906
 907 <p>A description of each parameter follows:</p></ol>
 908
 909 <h5>image</h5>
 910 <ol><p>the image.</p></ol>
 911
 912 <h5>mask</h5>
 913 <ol><p>the image mask.</p></ol>
 914
 915  </div>
 916 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 917 _8c.html" target="source" name="SetImageOpacity">SetImageOpacity</a></h2>
 918 <div class="doc-section">
 919
 920 <p>SetImageOpacity() sets the opacity levels of the image.</p></ol>
 921
 922 <p>The format of the SetImageOpacity method is:</p>
 923
 924 <pre class="code">
 925   MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
 926 </pre>
 927
 928 <p>A description of each parameter follows:</p></ol>
 929
 930 <h5>image</h5>
 931 <ol><p>the image.</p></ol>
 932
 933 <h5>opacity</h5>
 934 <ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
 935
 936  </div>
 937 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 938 _8c.html" target="source" name="SetImageType">SetImageType</a></h2>
 939 <div class="doc-section">
 940
 941 <p>SetImageType() sets the type of image.  Choose from these types:</p></ol>
 942
 943 <p>Bilevel        Grayscale       GrayscaleMatte Palette        PaletteMatte    TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte OptimizeType</p></ol>
 944
 945 <p>The format of the SetImageType method is:</p>
 946
 947 <pre class="code">
 948   MagickBooleanType SetImageType(Image *image,const ImageType type)
 949 </pre>
 950
 951 <p>A description of each parameter follows:</p></ol>
 952
 953 <h5>image</h5>
 954 <ol><p>the image.</p></ol>
 955
 956 <h5>type</h5>
 957 <ol><p>Image type.</p></ol>
 958
 959  </div>
 960 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 961 _8c.html" target="source" name="SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a></h2>
 962 <div class="doc-section">
 963
 964 <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>
 965
 966 <p>The format of the SetImageVirtualPixelMethod() method is:</p>
 967
 968 <pre class="code">
 969   VirtualPixelMethod SetImageVirtualPixelMethod(const Image *image,
 970     const VirtualPixelMethod virtual_pixel_method)
 971 </pre>
 972
 973 <p>A description of each parameter follows:</p></ol>
 974
 975 <h5>image</h5>
 976 <ol><p>the image.</p></ol>
 977
 978 <h5>virtual_pixel_method</h5>
 979 <ol><p>choose the type of virtual pixel.</p></ol>
 980
 981  </div>
 982 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 983 _8c.html" target="source" name="StripImage">StripImage</a></h2>
 984 <div class="doc-section">
 985
 986 <p>StripImage() strips an image of all profiles and comments.</p></ol>
 987
 988 <p>The format of the StripImage method is:</p>
 989
 990 <pre class="code">
 991   MagickBooleanType StripImage(Image *image)
 992 </pre>
 993
 994 <p>A description of each parameter follows:</p></ol>
 995
 996 <h5>image</h5>
 997 <ol><p>the image.</p></ol>
 998
 999  </div>
1000 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
1001 _8c.html" target="source" name="SyncImageSettings">SyncImageSettings</a></h2>
1002 <div class="doc-section">
1003
1004 <p>SyncImageSettings() sync the image info options to the image.</p></ol>
1005
1006 <p>The format of the SyncImageSettings method is:</p>
1007
1008 <pre class="code">
1009   MagickBooleanType SyncImageSettings(const ImageInfo *image_info,
1010     Image *image)
1011   MagickBooleanType SyncImagesSettings(const ImageInfo *image_info,
1012     Image *image)
1013 </pre>
1014
1015 <p>A description of each parameter follows:</p></ol>
1016
1017 <h5>image_info</h5>
1018 <ol><p>the image info.</p></ol>
1019
1020 <h5>image</h5>
1021 <ol><p>the image.</p></ol>
1022
1023  </div>
1024 \r
1025 </div>\r
1026 \r
1027 <div id="linkbar">\r
1028  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
1029     <span id="linkbar-center">\r
1030       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
1031       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
1032     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
1033     </span>\r
1034     <span id="linkbar-east">&nbsp;</span>\r
1035   </div>\r
1036   <div class="footer">\r
1037     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
1038     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
1039   </div>\r
1040   <div style="clear: both; margin: 0; width: 100%; "></div>\r
1041 </body>\r
1042 </html>\r