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