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