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