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

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