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

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