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