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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Deprecated 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="Generator" content="PHP"/>
  16   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, deprecated, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  17   <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."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.hygi.de">Reinigungsmittel</a><!-- 201002000400+ -->
 127 </div>
 128 <div  class="sponsor">
 129    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 130 </div>
 131 <div  class="sponsor">
 132    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <p class="navigation-index">[<a href="#AcquireCacheViewIndexes">AcquireCacheViewIndexes</a> &bull; <a href="#AcquireCacheViewPixels">AcquireCacheViewPixels</a> &bull; <a href="#AcquireImagePixels">AcquireImagePixels</a> &bull; <a href="#AcquireIndexes">AcquireIndexes</a> &bull; <a href="#AcquireMemory">AcquireMemory</a> &bull; <a href="#AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a> &bull; <a href="#AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a> &bull; <a href="#AcquireOneMagickPixel">AcquireOneMagickPixel</a> &bull; <a href="#AcquireOnePixel">AcquireOnePixel</a> &bull; <a href="#AcquireOneVirtualPixel">AcquireOneVirtualPixel</a> &bull; <a href="#AcquirePixels">AcquirePixels</a> &bull; <a href="#AffinityImage">AffinityImage</a> &bull; <a href="#AffinityImages">AffinityImages</a> &bull; <a href="#AllocateImage">AllocateImage</a> &bull; <a href="#AllocateImageColormap">AllocateImageColormap</a> &bull; <a href="#AllocateNextImage">AllocateNextImage</a> &bull; <a href="#AllocateString">AllocateString</a> &bull; <a href="#ChannelThresholdImage">ChannelThresholdImage</a> &bull; <a href="#ClipPathImage">ClipPathImage</a> &bull; <a href="#CloneImageAttributes">CloneImageAttributes</a> &bull; <a href="#CloneMemory">CloneMemory</a> &bull; <a href="#CloseCacheView">CloseCacheView</a> &bull; <a href="#ColorFloodfill">ColorFloodfill</a> &bull; <a href="#DeleteImageAttribute">DeleteImageAttribute</a> &bull; <a href="#DeleteImageList">DeleteImageList</a> &bull; <a href="#DeleteMagickRegistry">DeleteMagickRegistry</a> &bull; <a href="#DescribeImage">DescribeImage</a> &bull; <a href="#DestroyImageAttributes">DestroyImageAttributes</a> &bull; <a href="#DestroyImages">DestroyImages</a> &bull; <a href="#DestroyMagick">DestroyMagick</a> &bull; <a href="#DispatchImage">DispatchImage</a> &bull; <a href="#ExtractSubimageFromImageImage">ExtractSubimageFromImageImage</a> &bull; <a href="#FlattenImages">FlattenImages</a> &bull; <a href="#FormatImageAttribute">FormatImageAttribute</a> &bull; <a href="#FormatString">FormatString</a> &bull; <a href="#GetConfigureBlob">GetConfigureBlob</a> &bull; <a href="#GetCacheView">GetCacheView</a> &bull; <a href="#GetCacheViewIndexes">GetCacheViewIndexes</a> &bull; <a href="#GetCacheViewPixels">GetCacheViewPixels</a> &bull; <a href="#GetImageAttribute">GetImageAttribute</a> &bull; <a href="#GetImageClippingPathAttribute">GetImageClippingPathAttribute</a> &bull; <a href="#GetImageFromMagickRegistry">GetImageFromMagickRegistry</a> &bull; <a href="#GetMagickRegistry">GetMagickRegistry</a> &bull; <a href="#GetImageGeometry">GetImageGeometry</a> &bull; <a href="#GetImageList">GetImageList</a> &bull; <a href="#GetImageListIndex">GetImageListIndex</a> &bull; <a href="#GetImageListSize">GetImageListSize</a> &bull; <a href="#GetImagePixels">GetImagePixels</a> &bull; <a href="#GetIndexes">GetIndexes</a> &bull; <a href="#GetNextImage">GetNextImage</a> &bull; <a href="#GetNextImageAttribute">GetNextImageAttribute</a> &bull; <a href="#GetNumberScenes">GetNumberScenes</a> &bull; <a href="#GetOnePixel">GetOnePixel</a> &bull; <a href="#GetPixels">GetPixels</a> &bull; <a href="#GetPreviousImage">GetPreviousImage</a> &bull; <a href="#HSLTransform">HSLTransform</a> &bull; <a href="#IdentityAffine">IdentityAffine</a> &bull; <a href="#InitializeMagick">InitializeMagick</a> &bull; <a href="#InterpolatePixelColor">InterpolatePixelColor</a> &bull; <a href="#InterpretImageAttributes">InterpretImageAttributes</a> &bull; <a href="#LiberateMemory">LiberateMemory</a> &bull; <a href="#LiberateSemaphoreInfo">LiberateSemaphoreInfo</a> &bull; <a href="#MagickIncarnate">MagickIncarnate</a> &bull; <a href="#MagickMonitor">MagickMonitor</a> &bull; <a href="#MapImage">MapImage</a> &bull; <a href="#MapImages">MapImages</a> &bull; <a href="#MatteFloodfill">MatteFloodfill</a> &bull; <a href="#MosaicImages">MosaicImages</a> &bull; <a href="#OpaqueImage">OpaqueImage</a> &bull; <a href="#OpenCacheView">OpenCacheView</a> &bull; <a href="#PaintFloodfill">PaintFloodfill</a> &bull; <a href="#PaintOpaqueImage">PaintOpaqueImage</a> &bull; <a href="#PaintTransparentImage">PaintTransparentImage</a> &bull; <a href="#ParseSizeGeometry">ParseSizeGeometry</a> &bull; <a href="#PopImageList">PopImageList</a> &bull; <a href="#PopImagePixels">PopImagePixels</a> &bull; <a href="#PostscriptGeometry">PostscriptGeometry</a> &bull; <a href="#PushImageList">PushImageList</a> &bull; <a href="#PushImagePixels">PushImagePixels</a> &bull; <a href="#QuantizationError">QuantizationError</a> &bull; <a href="#RandomChannelThresholdImage">RandomChannelThresholdImage</a> &bull; <a href="#ReacquireMemory">ReacquireMemory</a> &bull; <a href="#ResetImageAttributeIterator">ResetImageAttributeIterator</a> &bull; <a href="#SetCacheViewPixels">SetCacheViewPixels</a> &bull; <a href="#SetExceptionInfo">SetExceptionInfo</a> &bull; <a href="#SetImage">SetImage</a> &bull; <a href="#SetImageAttribute">SetImageAttribute</a> &bull; <a href="#SetImageList">SetImageList</a> &bull; <a href="#SetImagePixels">SetImagePixels</a> &bull; <a href="#SetMagickRegistry">SetMagickRegistry</a> &bull; <a href="#SetMonitorHandler">SetMonitorHandler</a> &bull; <a href="#ShiftImageList">ShiftImageList</a> &bull; <a href="#SpliceImageList">SpliceImageList</a> &bull; <a href="#Strip">Strip</a> &bull; <a href="#SyncCacheView">SyncCacheView</a> &bull; <a href="#SyncCacheViewPixels">SyncCacheViewPixels</a> &bull; <a href="#SyncImagePixels">SyncImagePixels</a> &bull; <a href="#TemporaryFilename">TemporaryFilename</a> &bull; <a href="#ThresholdImage">ThresholdImage</a> &bull; <a href="#ThresholdImageChannel">ThresholdImageChannel</a> &bull; <a href="#TransformHSL">TransformHSL</a> &bull; <a href="#TranslateText">TranslateText</a> &bull; <a href="#TransparentImage">TransparentImage</a> &bull; <a href="#UnshiftImageList">UnshiftImageList</a>]</p>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 157 _8c.html" target="source" name="AcquireCacheViewIndexes">AcquireCacheViewIndexes</a></h2>
 158 <div class="doc-section">
 159
 160 <p>AcquireCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
 161
 162 <p>The format of the AcquireCacheViewIndexes method is:</p>
 163
 164 <pre class="code">
 165   const IndexPacket *AcquireCacheViewIndexes(const CacheView *cache_view)
 166 </pre>
 167
 168 <p>A description of each parameter follows:</p></ol>
 169
 170 <h5>cache_view</h5>
 171 <ol><p>the cache view.</p></ol>
 172
 173  </div>
 174 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 175 _8c.html" target="source" name="AcquireCacheViewPixels">AcquireCacheViewPixels</a></h2>
 176 <div class="doc-section">
 177
 178 <p>AcquireCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters.   A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
 179
 180 <p>The format of the AcquireCacheViewPixels method is:</p>
 181
 182 <pre class="code">
 183   const PixelPacket *AcquireCacheViewPixels(const CacheView *cache_view,
 184     const long x,const long y,const unsigned long columns,
 185     const unsigned long rows,ExceptionInfo *exception)
 186 </pre>
 187
 188 <p>A description of each parameter follows:</p></ol>
 189
 190 <h5>cache_view</h5>
 191 <ol><p>the cache view.</p></ol>
 192
 193 <h5>x,y,columns,rows</h5>
 194 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 195
 196 <h5>exception</h5>
 197 <ol><p>return any errors or warnings in this structure.</p></ol>
 198
 199  </div>
 200 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 201 _8c.html" target="source" name="AcquireImagePixels">AcquireImagePixels</a></h2>
 202 <div class="doc-section">
 203
 204 <p>AcquireImagePixels() returns an immutable pixel region. If the region is successfully accessed, a pointer to it is returned, otherwise NULL is returned. The returned pointer may point to a temporary working copy of the pixels or it may point to the original pixels in memory. Performance is maximized if the selected region is part of one row, or one or more full rows, since there is opportunity to access the pixels in-place (without a copy) if the image is in RAM, or in a memory-mapped file.  The returned pointer should *never* be deallocated by the user.</p></ol>
 205
 206 <p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket.  If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to access the black color component or to obtain the colormap indexes (of type IndexPacket) corresponding to the region.</p></ol>
 207
 208 <p>If you plan to modify the pixels, use GetAuthenticPixels() instead.</p></ol>
 209
 210 <p>Note, the AcquireImagePixels() and GetAuthenticPixels() methods are not thread-safe.  In a threaded environment, use GetCacheViewVirtualPixels() or GetCacheViewAuthenticPixels() instead.</p></ol>
 211
 212 <p>The format of the AcquireImagePixels() method is:</p>
 213
 214 <pre class="code">
 215   const PixelPacket *AcquireImagePixels(const Image *image,const long x,
 216     const long y,const unsigned long columns,const unsigned long rows,
 217     ExceptionInfo *exception)
 218 </pre>
 219
 220 <p>A description of each parameter follows:</p></ol>
 221
 222 <h5>image</h5>
 223 <ol><p>the image.</p></ol>
 224
 225 <h5>x,y,columns,rows</h5>
 226 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 227
 228 <h5>exception</h5>
 229 <ol><p>return any errors or warnings in this structure.</p></ol>
 230
 231  </div>
 232 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 233 _8c.html" target="source" name="AcquireIndexes">AcquireIndexes</a></h2>
 234 <div class="doc-section">
 235
 236 <p>AcquireIndexes() returns the black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the black channel or colormap indexes are not available.</p></ol>
 237
 238 <p>The format of the AcquireIndexes() method is:</p>
 239
 240 <pre class="code">
 241   const IndexPacket *AcquireIndexes(const Image *image)
 242 </pre>
 243
 244 <p>A description of each parameter follows:</p></ol>
 245
 246 <h5>indexes</h5>
 247 <ol><p>AcquireIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
 248
 249 <h5>image</h5>
 250 <ol><p>the image.</p></ol>
 251
 252  </div>
 253 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 254 _8c.html" target="source" name="AcquireMemory">AcquireMemory</a></h2>
 255 <div class="doc-section">
 256
 257 <p>AcquireMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.</p></ol>
 258
 259 <p>The format of the AcquireMemory method is:</p>
 260
 261 <pre class="code">
 262   void *AcquireMemory(const size_t size)
 263 </pre>
 264
 265 <p>A description of each parameter follows:</p></ol>
 266
 267 <h5>size</h5>
 268 <ol><p>the size of the memory in bytes to allocate.</p></ol>
 269
 270  </div>
 271 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 272 _8c.html" target="source" name="AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a></h2>
 273 <div class="doc-section">
 274
 275 <p>AcquireOneCacheViewPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.  If you plan to modify the pixel, use GetOneCacheViewAuthenticPixel() instead.</p></ol>
 276
 277 <p>The format of the AcquireOneCacheViewPixel method is:</p>
 278
 279 <pre class="code">
 280   MagickBooleanType AcquireOneCacheViewPixel(const CacheView *cache_view,
 281     const long x,const long y,PixelPacket *pixel,ExceptionInfo *exception)
 282 </pre>
 283
 284 <p>A description of each parameter follows:</p></ol>
 285
 286 <h5>cache_view</h5>
 287 <ol><p>the cache view.</p></ol>
 288
 289 <h5>x,y</h5>
 290 <ol><p>These values define the offset of the pixel.</p></ol>
 291
 292 <h5>pixel</h5>
 293 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 294
 295 <h5>exception</h5>
 296 <ol><p>return any errors or warnings in this structure.</p></ol>
 297
 298  </div>
 299 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 300 _8c.html" target="source" name="AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a></h2>
 301 <div class="doc-section">
 302
 303 <p>AcquireOneCacheViewVirtualPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneCacheViewAuthenticPixel() instead.</p></ol>
 304
 305 <p>The format of the AcquireOneCacheViewPixel method is:</p>
 306
 307 <pre class="code">
 308   MagickBooleanType AcquireOneCacheViewVirtualPixel(
 309     const CacheView *cache_view,
 310     const VirtualPixelMethod virtual_pixel_method,const long x,
 311     const long y,PixelPacket *pixel,ExceptionInfo *exception)
 312 </pre>
 313
 314 <p>A description of each parameter follows:</p></ol>
 315
 316 <h5>cache_view</h5>
 317 <ol><p>the cache view.</p></ol>
 318
 319 <h5>virtual_pixel_method</h5>
 320 <ol><p>the virtual pixel method.</p></ol>
 321
 322 <h5>x,y</h5>
 323 <ol><p>These values define the offset of the pixel.</p></ol>
 324
 325 <h5>pixel</h5>
 326 <ol><p>return a pixel at the specified (x,y) location.</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/deprecate
 333 _8c.html" target="source" name="AcquireOneMagickPixel">AcquireOneMagickPixel</a></h2>
 334 <div class="doc-section">
 335
 336 <p>AcquireOneMagickPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.  If you plan to modify the pixel, use GetOnePixel() instead.</p></ol>
 337
 338 <p>The format of the AcquireOneMagickPixel() method is:</p>
 339
 340 <pre class="code">
 341   MagickPixelPacket AcquireOneMagickPixel(const Image image,const long x,
 342     const long y,ExceptionInfo exception)
 343 </pre>
 344
 345 <p>A description of each parameter follows:</p></ol>
 346
 347 <h5>image</h5>
 348 <ol><p>the image.</p></ol>
 349
 350 <h5>x,y</h5>
 351 <ol><p>These values define the location of the pixel to return.</p></ol>
 352
 353 <h5>exception</h5>
 354 <ol><p>return any errors or warnings in this structure.</p></ol>
 355
 356  </div>
 357 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 358 _8c.html" target="source" name="AcquireOnePixel">AcquireOnePixel</a></h2>
 359 <div class="doc-section">
 360
 361 <p>AcquireOnePixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.  If you plan to modify the pixel, use GetOnePixel() instead.</p></ol>
 362
 363 <p>The format of the AcquireOnePixel() method is:</p>
 364
 365 <pre class="code">
 366   PixelPacket AcquireOnePixel(const Image image,const long x,
 367     const long y,ExceptionInfo exception)
 368 </pre>
 369
 370 <p>A description of each parameter follows:</p></ol>
 371
 372 <h5>image</h5>
 373 <ol><p>the image.</p></ol>
 374
 375 <h5>x,y</h5>
 376 <ol><p>These values define the location of the pixel to return.</p></ol>
 377
 378 <h5>exception</h5>
 379 <ol><p>return any errors or warnings in this structure.</p></ol>
 380
 381  </div>
 382 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 383 _8c.html" target="source" name="AcquireOneVirtualPixel">AcquireOneVirtualPixel</a></h2>
 384 <div class="doc-section">
 385
 386 <p>AcquireOneVirtualPixel() returns a single pixel at the specified (x,y) location as defined by specified pixel method.  The image background color is returned if an error occurs.  If you plan to modify the pixel, use GetOnePixel() instead.</p></ol>
 387
 388 <p>The format of the AcquireOneVirtualPixel() method is:</p>
 389
 390 <pre class="code">
 391   PixelPacket AcquireOneVirtualPixel(const Image image,
 392     const VirtualPixelMethod virtual_pixel_method,const long x,
 393     const long y,ExceptionInfo exception)
 394 </pre>
 395
 396 <p>A description of each parameter follows:</p></ol>
 397
 398 <h5>virtual_pixel_method</h5>
 399 <ol><p>the virtual pixel method.</p></ol>
 400
 401 <h5>image</h5>
 402 <ol><p>the image.</p></ol>
 403
 404 <h5>x,y</h5>
 405 <ol><p>These values define the location of the pixel to return.</p></ol>
 406
 407 <h5>exception</h5>
 408 <ol><p>return any errors or warnings in this structure.</p></ol>
 409
 410  </div>
 411 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 412 _8c.html" target="source" name="AcquirePixels">AcquirePixels</a></h2>
 413 <div class="doc-section">
 414
 415 <p>AcquirePixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
 416
 417 <p>The format of the AcquirePixels() method is:</p>
 418
 419 <pre class="code">
 420   const PixelPacket *AcquirePixels(const Image image)
 421 </pre>
 422
 423 <p>A description of each parameter follows:</p></ol>
 424
 425 <h5>image</h5>
 426 <ol><p>the image.</p></ol>
 427
 428  </div>
 429 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 430 _8c.html" target="source" name="AffinityImage">AffinityImage</a></h2>
 431 <div class="doc-section">
 432
 433 <p>AffinityImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
 434
 435 <p>The format of the AffinityImage method is:</p>
 436
 437 <pre class="code">
 438   MagickBooleanType AffinityImage(const QuantizeInfo *quantize_info,
 439     Image *image,const Image *affinity_image)
 440 </pre>
 441
 442 <p>A description of each parameter follows:</p></ol>
 443
 444 <h5>quantize_info</h5>
 445 <ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
 446
 447 <h5>image</h5>
 448 <ol><p>the image.</p></ol>
 449
 450 <h5>affinity_image</h5>
 451 <ol><p>the reference image.</p></ol>
 452
 453  </div>
 454 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 455 _8c.html" target="source" name="AffinityImages">AffinityImages</a></h2>
 456 <div class="doc-section">
 457
 458 <p>AffinityImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
 459
 460 <p>The format of the AffinityImage method is:</p>
 461
 462 <pre class="code">
 463   MagickBooleanType AffinityImages(const QuantizeInfo *quantize_info,
 464     Image *images,Image *affinity_image)
 465 </pre>
 466
 467 <p>A description of each parameter follows:</p></ol>
 468
 469 <h5>quantize_info</h5>
 470 <ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
 471
 472 <h5>images</h5>
 473 <ol><p>the image sequence.</p></ol>
 474
 475 <h5>affinity_image</h5>
 476 <ol><p>the reference image.</p></ol>
 477
 478  </div>
 479 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 480 _8c.html" target="source" name="AllocateImage">AllocateImage</a></h2>
 481 <div class="doc-section">
 482
 483 <p>AllocateImage() returns a pointer to an image structure initialized to default values.</p></ol>
 484
 485 <p>The format of the AllocateImage method is:</p>
 486
 487 <pre class="code">
 488   Image *AllocateImage(const ImageInfo *image_info)
 489 </pre>
 490
 491 <p>A description of each parameter follows:</p></ol>
 492
 493 <h5>image_info</h5>
 494 <ol><p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p></ol>
 495
 496  </div>
 497 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 498 _8c.html" target="source" name="AllocateImageColormap">AllocateImageColormap</a></h2>
 499 <div class="doc-section">
 500
 501 <p>AllocateImageColormap() allocates an image colormap and initializes it to a linear gray colorspace.  If the image already has a colormap, it is replaced.  AllocateImageColormap() returns MagickTrue if successful, otherwise MagickFalse if there is not enough memory.</p></ol>
 502
 503 <p>The format of the AllocateImageColormap method is:</p>
 504
 505 <pre class="code">
 506   MagickBooleanType AllocateImageColormap(Image *image,
 507     const unsigned long colors)
 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 <h5>colors</h5>
 516 <ol><p>the number of colors in the image colormap.</p></ol>
 517
 518  </div>
 519 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 520 _8c.html" target="source" name="AllocateNextImage">AllocateNextImage</a></h2>
 521 <div class="doc-section">
 522
 523 <p>AllocateNextImage() 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>
 524
 525 <p>The format of the AllocateNextImage method is:</p>
 526
 527 <pre class="code">
 528   void AllocateNextImage(const ImageInfo *image_info,Image *image)
 529 </pre>
 530
 531 <p>A description of each parameter follows:</p></ol>
 532
 533 <h5>image_info</h5>
 534 <ol><p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p></ol>
 535
 536 <h5>image</h5>
 537 <ol><p>the image.</p></ol>
 538
 539  </div>
 540 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 541 _8c.html" target="source" name="AllocateString">AllocateString</a></h2>
 542 <div class="doc-section">
 543
 544 <p>AllocateString() allocates memory for a string and copies the source string to that memory location (and returns it).</p></ol>
 545
 546 <p>The format of the AllocateString method is:</p>
 547
 548 <pre class="code">
 549   char *AllocateString(const char *source)
 550 </pre>
 551
 552 <p>A description of each parameter follows:</p></ol>
 553
 554 <h5>source</h5>
 555 <ol><p>A character string.</p></ol>
 556
 557  </div>
 558 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 559 _8c.html" target="source" name="ChannelThresholdImage">ChannelThresholdImage</a></h2>
 560 <div class="doc-section">
 561
 562 <p>ChannelThresholdImage() changes the value of individual pixels based on the intensity of each pixel channel.  The result is a high-contrast image.</p></ol>
 563
 564 <p>The format of the ChannelThresholdImage method is:</p>
 565
 566 <pre class="code">
 567   unsigned int ChannelThresholdImage(Image *image,const char *level)
 568 </pre>
 569
 570 <p>A description of each parameter follows:</p></ol>
 571
 572 <h5>image</h5>
 573 <ol><p>the image.</p></ol>
 574
 575 <h5>level</h5>
 576 <ol><p>define the threshold values.</p></ol>
 577
 578  </div>
 579 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 580 _8c.html" target="source" name="ClipPathImage">ClipPathImage</a></h2>
 581 <div class="doc-section">
 582
 583 <p>ClipPathImage() sets the image clip mask based any clipping path information if it exists.</p></ol>
 584
 585 <p>The format of the ClipImage method is:</p>
 586
 587 <pre class="code">
 588   MagickBooleanType ClipPathImage(Image *image,const char *pathname,
 589     const MagickBooleanType inside)
 590 </pre>
 591
 592 <p>A description of each parameter follows:</p></ol>
 593
 594 <h5>image</h5>
 595 <ol><p>the image.</p></ol>
 596
 597 <h5>pathname</h5>
 598 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
 599
 600 <h5>inside</h5>
 601 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
 602
 603  </div>
 604 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 605 _8c.html" target="source" name="CloneImageAttributes">CloneImageAttributes</a></h2>
 606 <div class="doc-section">
 607
 608 <p>CloneImageAttributes() clones one or more image attributes.</p></ol>
 609
 610 <p>The format of the CloneImageAttributes method is:</p>
 611
 612 <pre class="code">
 613   MagickBooleanType CloneImageAttributes(Image *image,
 614     const Image *clone_image)
 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>clone_image</h5>
 623 <ol><p>the clone image.</p></ol>
 624
 625  </div>
 626 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 627 _8c.html" target="source" name="CloneMemory">CloneMemory</a></h2>
 628 <div class="doc-section">
 629
 630 <p>CloneMemory() copies size bytes from memory area source to the destination. Copying between objects that overlap will take place correctly.  It returns destination.</p></ol>
 631
 632 <p>The format of the CloneMemory method is:</p>
 633
 634 <pre class="code">
 635   void *CloneMemory(void *destination,const void *source,
 636     const size_t size)
 637 </pre>
 638
 639 <p>A description of each parameter follows:</p></ol>
 640
 641 <h5>destination</h5>
 642 <ol><p>the destination.</p></ol>
 643
 644 <h5>source</h5>
 645 <ol><p>the source.</p></ol>
 646
 647 <h5>size</h5>
 648 <ol><p>the size of the memory in bytes to allocate.</p></ol>
 649
 650  </div>
 651 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 652 _8c.html" target="source" name="CloseCacheView">CloseCacheView</a></h2>
 653 <div class="doc-section">
 654
 655 <p>CloseCacheView() closes the specified view returned by a previous call to OpenCacheView().</p></ol>
 656
 657 <p>The format of the CloseCacheView method is:</p>
 658
 659 <pre class="code">
 660   CacheView *CloseCacheView(CacheView *view_info)
 661 </pre>
 662
 663 <p>A description of each parameter follows:</p></ol>
 664
 665 <h5>view_info</h5>
 666 <ol><p>the address of a structure of type CacheView.</p></ol>
 667
 668  </div>
 669 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 670 _8c.html" target="source" name="ColorFloodfill">ColorFloodfill</a></h2>
 671 <div class="doc-section">
 672
 673 <p>ColorFloodfill() changes the color value of any pixel that matches target and is an immediate neighbor.  If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.</p></ol>
 674
 675 <p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount.  The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same.  For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p></ol>
 676
 677 <p>The format of the ColorFloodfillImage method is:</p>
 678
 679 <pre class="code">
 680   MagickBooleanType ColorFloodfillImage(Image *image,
 681     const DrawInfo *draw_info,const PixelPacket target,
 682     const long x_offset,const long y_offset,const PaintMethod method)
 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>draw_info</h5>
 691 <ol><p>the draw info.</p></ol>
 692
 693 <h5>target</h5>
 694 <ol><p>the RGB value of the target color.</p></ol>
 695
 696 <h5>x,y</h5>
 697 <ol><p>the starting location of the operation.</p></ol>
 698
 699 <h5>method</h5>
 700 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
 701
 702  </div>
 703 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 704 _8c.html" target="source" name="DeleteImageAttribute">DeleteImageAttribute</a></h2>
 705 <div class="doc-section">
 706
 707 <p>DeleteImageAttribute() deletes an attribute from the image.</p></ol>
 708
 709 <p>The format of the DeleteImageAttribute method is:</p>
 710
 711 <pre class="code">
 712   MagickBooleanType DeleteImageAttribute(Image *image,const char *key)
 713 </pre>
 714
 715 <p>A description of each parameter follows:</p></ol>
 716
 717 <h5>image</h5>
 718 <ol><p>the image info.</p></ol>
 719
 720 <h5>key</h5>
 721 <ol><p>the image key.</p></ol>
 722
 723  </div>
 724 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 725 _8c.html" target="source" name="DeleteImageList">DeleteImageList</a></h2>
 726 <div class="doc-section">
 727
 728 <p>DeleteImageList() deletes an image at the specified position in the list.</p></ol>
 729
 730 <p>The format of the DeleteImageList method is:</p>
 731
 732 <pre class="code">
 733   unsigned int DeleteImageList(Image *images,const long offset)
 734 </pre>
 735
 736 <p>A description of each parameter follows:</p></ol>
 737
 738 <h5>images</h5>
 739 <ol><p>the image list.</p></ol>
 740
 741 <h5>offset</h5>
 742 <ol><p>the position within the list.</p></ol>
 743
 744  </div>
 745 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 746 _8c.html" target="source" name="DeleteMagickRegistry">DeleteMagickRegistry</a></h2>
 747 <div class="doc-section">
 748
 749 <p>DeleteMagickRegistry() deletes an entry in the registry as defined by the id. It returns MagickTrue if the entry is deleted otherwise MagickFalse if no entry is found in the registry that matches the id.</p></ol>
 750
 751 <p>The format of the DeleteMagickRegistry method is:</p>
 752
 753 <pre class="code">
 754   MagickBooleanType DeleteMagickRegistry(const long id)
 755 </pre>
 756
 757 <p>A description of each parameter follows:</p></ol>
 758
 759 <h5>id</h5>
 760 <ol><p>the registry id.</p></ol>
 761
 762  </div>
 763 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 764 _8c.html" target="source" name="DescribeImage">DescribeImage</a></h2>
 765 <div class="doc-section">
 766
 767 <p>DescribeImage() describes an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p></ol>
 768
 769 <p>The format of the DescribeImage method is:</p>
 770
 771 <pre class="code">
 772   MagickBooleanType DescribeImage(Image *image,FILE *file,
 773     const MagickBooleanType verbose)
 774 </pre>
 775
 776 <p>A description of each parameter follows:</p></ol>
 777
 778 <h5>image</h5>
 779 <ol><p>the image.</p></ol>
 780
 781 <h5>file</h5>
 782 <ol><p>the file, typically stdout.</p></ol>
 783
 784 <h5>verbose</h5>
 785 <ol><p>A value other than zero prints more detailed information about the image.</p></ol>
 786
 787  </div>
 788 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 789 _8c.html" target="source" name="DestroyImageAttributes">DestroyImageAttributes</a></h2>
 790 <div class="doc-section">
 791
 792 <p>DestroyImageAttributes() deallocates memory associated with the image attribute list.</p></ol>
 793
 794 <p>The format of the DestroyImageAttributes method is:</p>
 795
 796 <pre class="code">
 797   DestroyImageAttributes(Image *image)
 798 </pre>
 799
 800 <p>A description of each parameter follows:</p></ol>
 801
 802 <h5>image</h5>
 803 <ol><p>the image.</p></ol>
 804
 805  </div>
 806 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 807 _8c.html" target="source" name="DestroyImages">DestroyImages</a></h2>
 808 <div class="doc-section">
 809
 810 <p>DestroyImages() destroys an image list.</p></ol>
 811
 812 <p>The format of the DestroyImages method is:</p>
 813
 814 <pre class="code">
 815   void DestroyImages(Image *image)
 816 </pre>
 817
 818 <p>A description of each parameter follows:</p></ol>
 819
 820 <h5>image</h5>
 821 <ol><p>the image sequence.</p></ol>
 822
 823  </div>
 824 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 825 _8c.html" target="source" name="DestroyMagick">DestroyMagick</a></h2>
 826 <div class="doc-section">
 827
 828 <p>DestroyMagick() destroys the ImageMagick environment.</p></ol>
 829
 830 <p>The format of the DestroyMagick function is:</p>
 831
 832 <pre class="text">
 833   DestroyMagick(void)
 834 </pre>
 835
 836  </div>
 837 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 838 _8c.html" target="source" name="DispatchImage">DispatchImage</a></h2>
 839 <div class="doc-section">
 840
 841 <p>DispatchImage() extracts pixel data from an image and returns it to you. The method returns MagickFalse on success otherwise MagickTrue if an error is encountered.  The data is returned as char, short int, int, long, float, or double in the order specified by map.</p></ol>
 842
 843 <p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
 844
 845 <pre class="text">
 846   DispatchImage(image,0,0,640,1,"RGB",CharPixel,pixels,exception);
 847 </pre>
 848
 849 <p>The format of the DispatchImage method is:</p>
 850
 851 <pre class="code">
 852   unsigned int DispatchImage(const Image *image,const long x_offset,
 853     const long y_offset,const unsigned long columns,
 854     const unsigned long rows,const char *map,const StorageType type,
 855     void *pixels,ExceptionInfo *exception)
 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>x_offset, y_offset, columns, rows</h5>
 864 <ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
 865
 866 <h5>map</h5>
 867 <ol><p>This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha, C = cyan, Y = yellow, M = magenta, K = black, or I = intensity (for grayscale).</p></ol>
 868
 869 <h5>type</h5>
 870 <ol><p>Define the data type of the pixels.  Float and double types are normalized to [0..1] otherwise [0..QuantumRange].  Choose from these types: CharPixel, ShortPixel, IntegerPixel, LongPixel, FloatPixel, or DoublePixel.</p></ol>
 871
 872 <h5>pixels</h5>
 873 <ol><p>This array of values contain the pixel components as defined by map and type.  You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.</p></ol>
 874
 875 <h5>exception</h5>
 876 <ol><p>return any errors or warnings in this structure.</p></ol>
 877
 878  </div>
 879 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 880 _8c.html" target="source" name="ExtractSubimageFromImageImage">ExtractSubimageFromImageImage</a></h2>
 881 <div class="doc-section">
 882
 883 <p>ExtractSubimageFromImageImage() extracts a region of the image that most closely resembles the reference.</p></ol>
 884
 885 <p>The format of the ExtractSubimageFromImageImage method is:</p>
 886
 887 <pre class="code">
 888   Image *ExtractSubimageFromImage(const Image *image,const Image *reference,
 889     ExceptionInfo *exception)
 890 </pre>
 891
 892 <p>A description of each parameter follows:</p></ol>
 893
 894 <h5>image</h5>
 895 <ol><p>the image.</p></ol>
 896
 897 <h5>reference</h5>
 898 <ol><p>find an area of the image that closely resembles this image.</p></ol>
 899
 900 <h5>exception</h5>
 901 <ol><p>return any errors or warnings in this structure.</p></ol>
 902
 903  </div>
 904 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 905 _8c.html" target="source" name="FlattenImages">FlattenImages</a></h2>
 906 <div class="doc-section">
 907
 908 <p>FlattenImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
 909
 910 <p>The format of the FlattenImage method is:</p>
 911
 912 <pre class="code">
 913   Image *FlattenImage(Image *image,ExceptionInfo *exception)
 914 </pre>
 915
 916 <p>A description of each parameter follows:</p></ol>
 917
 918 <h5>image</h5>
 919 <ol><p>the image sequence.</p></ol>
 920
 921 <h5>exception</h5>
 922 <ol><p>return any errors or warnings in this structure.</p></ol>
 923
 924  </div>
 925 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 926 _8c.html" target="source" name="FormatImageAttribute">FormatImageAttribute</a></h2>
 927 <div class="doc-section">
 928
 929 <p>FormatImageAttribute() permits formatted key/value pairs to be saved as an image attribute.</p></ol>
 930
 931 <p>The format of the FormatImageAttribute method is:</p>
 932
 933 <pre class="code">
 934   MagickBooleanType FormatImageAttribute(Image *image,const char *key,
 935     const char *format,...)
 936 </pre>
 937
 938 <p>A description of each parameter follows.</p></ol>
 939
 940 <h5> image</h5>
 941 <ol><p>The image.</p></ol>
 942
 943 <h5> key</h5>
 944 <ol><p>The attribute key.</p></ol>
 945
 946 <h5> format</h5>
 947 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
 948
 949  </div>
 950 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 951 _8c.html" target="source" name="FormatString">FormatString</a></h2>
 952 <div class="doc-section">
 953
 954 <p>FormatString() prints formatted output of a variable argument list.</p></ol>
 955
 956 <p>The format of the FormatString method is:</p>
 957
 958 <pre class="code">
 959   void FormatString(char *string,const char *format,...)
 960 </pre>
 961
 962 <p>A description of each parameter follows.</p></ol>
 963
 964 <h5> string</h5>
 965 <ol><p>Method FormatString returns the formatted string in this character buffer.</p></ol>
 966
 967 <h5> format</h5>
 968 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
 969
 970  </div>
 971 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 972 _8c.html" target="source" name="GetConfigureBlob">GetConfigureBlob</a></h2>
 973 <div class="doc-section">
 974
 975 <p>GetConfigureBlob() returns the specified configure file as a blob.</p></ol>
 976
 977 <p>The format of the GetConfigureBlob method is:</p>
 978
 979 <pre class="code">
 980   void *GetConfigureBlob(const char *filename,ExceptionInfo *exception)
 981 </pre>
 982
 983 <p>A description of each parameter follows:</p></ol>
 984
 985 <h5>filename</h5>
 986 <ol><p>the configure file name.</p></ol>
 987
 988 <h5>path</h5>
 989 <ol><p>return the full path information of the configure file.</p></ol>
 990
 991 <h5>length</h5>
 992 <ol><p>This pointer to a size_t integer sets the initial length of the blob.  On return, it reflects the actual length of the blob.</p></ol>
 993
 994 <h5>exception</h5>
 995 <ol><p>return any errors or warnings in this structure.</p></ol>
 996
 997  </div>
 998 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 999 _8c.html" target="source" name="GetCacheView">GetCacheView</a></h2>
1000 <div class="doc-section">
1001
1002 <p>GetCacheView() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters.   A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
1003
1004 <p>The format of the GetCacheView method is:</p>
1005
1006 <pre class="code">
1007   PixelPacket *GetCacheView(CacheView *cache_view,const long x,
1008     const long y,const unsigned long columns,const unsigned long rows)
1009 </pre>
1010
1011 <p>A description of each parameter follows:</p></ol>
1012
1013 <h5>cache_view</h5>
1014 <ol><p>the address of a structure of type CacheView.</p></ol>
1015
1016 <h5>x,y,columns,rows</h5>
1017 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1018
1019  </div>
1020 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1021 _8c.html" target="source" name="GetCacheViewIndexes">GetCacheViewIndexes</a></h2>
1022 <div class="doc-section">
1023
1024 <p>GetCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
1025
1026 <p>The format of the GetCacheViewIndexes method is:</p>
1027
1028 <pre class="code">
1029   IndexPacket *GetCacheViewIndexes(CacheView *cache_view)
1030 </pre>
1031
1032 <p>A description of each parameter follows:</p></ol>
1033
1034 <h5>cache_view</h5>
1035 <ol><p>the cache view.</p></ol>
1036
1037  </div>
1038 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1039 _8c.html" target="source" name="GetCacheViewPixels">GetCacheViewPixels</a></h2>
1040 <div class="doc-section">
1041
1042 <p>GetCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters.   A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
1043
1044 <p>The format of the GetCacheViewPixels method is:</p>
1045
1046 <pre class="code">
1047   PixelPacket *GetCacheViewPixels(CacheView *cache_view,const long x,
1048     const long y,const unsigned long columns,const unsigned long rows)
1049 </pre>
1050
1051 <p>A description of each parameter follows:</p></ol>
1052
1053 <h5>cache_view</h5>
1054 <ol><p>the cache view.</p></ol>
1055
1056 <h5>x,y,columns,rows</h5>
1057 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1058
1059  </div>
1060 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1061 _8c.html" target="source" name="GetImageAttribute">GetImageAttribute</a></h2>
1062 <div class="doc-section">
1063
1064 <p>GetImageAttribute() searches the list of image attributes and returns a pointer to the attribute if it exists otherwise NULL.</p></ol>
1065
1066 <p>The format of the GetImageAttribute method is:</p>
1067
1068 <pre class="code">
1069   const ImageAttribute *GetImageAttribute(const Image *image,
1070     const char *key)
1071 </pre>
1072
1073 <p>A description of each parameter follows:</p></ol>
1074
1075 <h5>image</h5>
1076 <ol><p>the image.</p></ol>
1077
1078 <h5>key</h5>
1079 <ol><p>These character strings are the name of an image attribute to return.</p></ol>
1080
1081  </div>
1082 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1083 _8c.html" target="source" name="GetImageClippingPathAttribute">GetImageClippingPathAttribute</a></h2>
1084 <div class="doc-section">
1085
1086 <p>GetImageClippingPathAttribute() searches the list of image attributes and returns a pointer to a clipping path if it exists otherwise NULL.</p></ol>
1087
1088 <p>The format of the GetImageClippingPathAttribute method is:</p>
1089
1090 <pre class="code">
1091   const ImageAttribute *GetImageClippingPathAttribute(Image *image)
1092 </pre>
1093
1094 <p>A description of each parameter follows:</p></ol>
1095
1096 <h5>attribute</h5>
1097 <ol><p>Method GetImageClippingPathAttribute returns the clipping path if it exists otherwise NULL.</p></ol>
1098
1099 <h5>image</h5>
1100 <ol><p>the image.</p></ol>
1101
1102  </div>
1103 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1104 _8c.html" target="source" name="GetImageFromMagickRegistry">GetImageFromMagickRegistry</a></h2>
1105 <div class="doc-section">
1106
1107 <p>GetImageFromMagickRegistry() gets an image from the registry as defined by its name.  If the image is not found, a NULL image is returned.</p></ol>
1108
1109 <p>The format of the GetImageFromMagickRegistry method is:</p>
1110
1111 <pre class="code">
1112   Image *GetImageFromMagickRegistry(const char *name,long *id,
1113     ExceptionInfo *exception)
1114 </pre>
1115
1116 <p>A description of each parameter follows:</p></ol>
1117
1118 <h5>name</h5>
1119 <ol><p>the name of the image to retrieve from the registry.</p></ol>
1120
1121 <h5>id</h5>
1122 <ol><p>the registry id.</p></ol>
1123
1124 <h5>exception</h5>
1125 <ol><p>return any errors or warnings in this structure.</p></ol>
1126
1127  </div>
1128 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1129 _8c.html" target="source" name="GetMagickRegistry">GetMagickRegistry</a></h2>
1130 <div class="doc-section">
1131
1132 <p>GetMagickRegistry() gets a blob from the registry as defined by the id.  If the blob that matches the id is not found, NULL is returned.</p></ol>
1133
1134 <p>The format of the GetMagickRegistry method is:</p>
1135
1136 <pre class="code">
1137   const void *GetMagickRegistry(const long id,RegistryType *type,
1138     size_t *length,ExceptionInfo *exception)
1139 </pre>
1140
1141 <p>A description of each parameter follows:</p></ol>
1142
1143 <h5>id</h5>
1144 <ol><p>the registry id.</p></ol>
1145
1146 <h5>type</h5>
1147 <ol><p>the registry type.</p></ol>
1148
1149 <h5>length</h5>
1150 <ol><p>the blob length in number of bytes.</p></ol>
1151
1152 <h5>exception</h5>
1153 <ol><p>return any errors or warnings in this structure.</p></ol>
1154
1155  </div>
1156 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1157 _8c.html" target="source" name="GetImageGeometry">GetImageGeometry</a></h2>
1158 <div class="doc-section">
1159
1160 <p>GetImageGeometry() returns a region as defined by the geometry string with respect to the image and its gravity.</p></ol>
1161
1162 <p>The format of the GetImageGeometry method is:</p>
1163
1164 <pre class="code">
1165   int GetImageGeometry(Image *image,const char *geometry,
1166     const unsigned int size_to_fit,RectangeInfo *region_info)
1167 </pre>
1168
1169 <p>A description of each parameter follows:</p></ol>
1170
1171 <h5>flags</h5>
1172 <ol><p>Method GetImageGeometry returns a bitmask that indicates which of the four values were located in the geometry string.</p></ol>
1173
1174 <h5>geometry</h5>
1175 <ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
1176
1177 <h5>size_to_fit</h5>
1178 <ol><p>A value other than 0 means to scale the region so it fits within the specified width and height.</p></ol>
1179
1180 <h5>region_info</h5>
1181 <ol><p>the region as defined by the geometry string with respect to the image and its gravity.</p></ol>
1182
1183  </div>
1184 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1185 _8c.html" target="source" name="GetImageList">GetImageList</a></h2>
1186 <div class="doc-section">
1187
1188 <p>GetImageList() returns an image at the specified position in the list.</p></ol>
1189
1190 <p>The format of the GetImageList method is:</p>
1191
1192 <pre class="code">
1193   Image *GetImageList(const Image *images,const long offset,
1194     ExceptionInfo *exception)
1195 </pre>
1196
1197 <p>A description of each parameter follows:</p></ol>
1198
1199 <h5>images</h5>
1200 <ol><p>the image list.</p></ol>
1201
1202 <h5>offset</h5>
1203 <ol><p>the position within the list.</p></ol>
1204
1205 <h5>exception</h5>
1206 <ol><p>return any errors or warnings in this structure.</p></ol>
1207
1208  </div>
1209 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1210 _8c.html" target="source" name="GetImageListIndex">GetImageListIndex</a></h2>
1211 <div class="doc-section">
1212
1213 <p>GetImageListIndex() returns the position in the list of the specified image.</p></ol>
1214
1215 <p>The format of the GetImageListIndex method is:</p>
1216
1217 <pre class="code">
1218   long GetImageListIndex(const Image *images)
1219 </pre>
1220
1221 <p>A description of each parameter follows:</p></ol>
1222
1223 <h5>images</h5>
1224 <ol><p>the image list.</p></ol>
1225
1226  </div>
1227 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1228 _8c.html" target="source" name="GetImageListSize">GetImageListSize</a></h2>
1229 <div class="doc-section">
1230
1231 <p>GetImageListSize() returns the number of images in the list.</p></ol>
1232
1233 <p>The format of the GetImageListSize method is:</p>
1234
1235 <pre class="code">
1236   unsigned long GetImageListSize(const Image *images)
1237 </pre>
1238
1239 <p>A description of each parameter follows:</p></ol>
1240
1241 <h5>images</h5>
1242 <ol><p>the image list.</p></ol>
1243
1244  </div>
1245 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1246 _8c.html" target="source" name="GetImagePixels">GetImagePixels</a></h2>
1247 <div class="doc-section">
1248
1249 <p>GetImagePixels() obtains a pixel region for read/write access. If the region is successfully accessed, a pointer to a PixelPacket array representing the region is returned, otherwise NULL is returned.</p></ol>
1250
1251 <p>The returned pointer may point to a temporary working copy of the pixels or it may point to the original pixels in memory. Performance is maximized if the selected region is part of one row, or one or more full rows, since then there is opportunity to access the pixels in-place (without a copy) if the image is in RAM, or in a memory-mapped file. The returned pointer should *never* be deallocated by the user.</p></ol>
1252
1253 <p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or if the storage class is PseduoClass, call GetAuthenticIndexQueue() after invoking GetImagePixels() to obtain the black color component or colormap indexes (of type IndexPacket) corresponding to the region.  Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.</p></ol>
1254
1255 <p>The format of the GetImagePixels() method is:</p>
1256
1257 <pre class="code">
1258   PixelPacket *GetImagePixels(Image *image,const long x,const long y,
1259     const unsigned long columns,const unsigned long rows)
1260 </pre>
1261
1262 <p>A description of each parameter follows:</p></ol>
1263
1264 <h5>image</h5>
1265 <ol><p>the image.</p></ol>
1266
1267 <h5>x,y,columns,rows</h5>
1268 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1269
1270  </div>
1271 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1272 _8c.html" target="source" name="GetIndexes">GetIndexes</a></h2>
1273 <div class="doc-section">
1274
1275 <p>GetIndexes() returns the black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().  NULL is returned if the black channel or colormap indexes are not available.</p></ol>
1276
1277 <p>The format of the GetIndexes() method is:</p>
1278
1279 <pre class="code">
1280   IndexPacket *GetIndexes(const Image *image)
1281 </pre>
1282
1283 <p>A description of each parameter follows:</p></ol>
1284
1285 <h5>indexes</h5>
1286 <ol><p>GetIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1287
1288 <h5>image</h5>
1289 <ol><p>the image.</p></ol>
1290
1291  </div>
1292 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1293 _8c.html" target="source" name="GetNextImage">GetNextImage</a></h2>
1294 <div class="doc-section">
1295
1296 <p>GetNextImage() returns the next image in a list.</p></ol>
1297
1298 <p>The format of the GetNextImage method is:</p>
1299
1300 <pre class="code">
1301   Image *GetNextImage(const Image *images)
1302 </pre>
1303
1304 <p>A description of each parameter follows:</p></ol>
1305
1306 <h5>images</h5>
1307 <ol><p>the image list.</p></ol>
1308
1309  </div>
1310 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1311 _8c.html" target="source" name="GetNextImageAttribute">GetNextImageAttribute</a></h2>
1312 <div class="doc-section">
1313
1314 <p>GetNextImageAttribute() gets the next image attribute.</p></ol>
1315
1316 <p>The format of the GetNextImageAttribute method is:</p>
1317
1318 <pre class="code">
1319   const ImageAttribute *GetNextImageAttribute(const Image *image)
1320 </pre>
1321
1322 <p>A description of each parameter follows:</p></ol>
1323
1324 <h5>image</h5>
1325 <ol><p>the image.</p></ol>
1326
1327  </div>
1328 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1329 _8c.html" target="source" name="GetNumberScenes">GetNumberScenes</a></h2>
1330 <div class="doc-section">
1331
1332 <p>GetNumberScenes() returns the number of images in the list.</p></ol>
1333
1334 <p>The format of the GetNumberScenes method is:</p>
1335
1336 <pre class="code">
1337   unsigned int GetNumberScenes(const Image *images)
1338 </pre>
1339
1340 <p>A description of each parameter follows:</p></ol>
1341
1342 <h5>images</h5>
1343 <ol><p>the image list.</p></ol>
1344
1345  </div>
1346 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1347 _8c.html" target="source" name="GetOnePixel">GetOnePixel</a></h2>
1348 <div class="doc-section">
1349
1350 <p>GetOnePixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
1351
1352 <p>The format of the GetOnePixel() method is:</p>
1353
1354 <pre class="code">
1355   PixelPacket GetOnePixel(const Image image,const long x,const long y)
1356 </pre>
1357
1358 <p>A description of each parameter follows:</p></ol>
1359
1360 <h5>image</h5>
1361 <ol><p>the image.</p></ol>
1362
1363 <h5>x,y</h5>
1364 <ol><p>These values define the location of the pixel to return.</p></ol>
1365
1366  </div>
1367 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1368 _8c.html" target="source" name="GetPixels">GetPixels</a></h2>
1369 <div class="doc-section">
1370
1371 <p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1372
1373 <p>The format of the GetPixels() method is:</p>
1374
1375 <pre class="code">
1376   PixelPacket *GetPixels(const Image image)
1377 </pre>
1378
1379 <p>A description of each parameter follows:</p></ol>
1380
1381 <h5>pixels</h5>
1382 <ol><p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1383
1384 <h5>image</h5>
1385 <ol><p>the image.</p></ol>
1386
1387  </div>
1388 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1389 _8c.html" target="source" name="GetPreviousImage">GetPreviousImage</a></h2>
1390 <div class="doc-section">
1391
1392 <p>GetPreviousImage() returns the previous image in a list.</p></ol>
1393
1394 <p>The format of the GetPreviousImage method is:</p>
1395
1396 <pre class="code">
1397   Image *GetPreviousImage(const Image *images)
1398 </pre>
1399
1400 <p>A description of each parameter follows:</p></ol>
1401
1402 <h5>images</h5>
1403 <ol><p>the image list.</p></ol>
1404
1405  </div>
1406 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1407 _8c.html" target="source" name="HSLTransform">HSLTransform</a></h2>
1408 <div class="doc-section">
1409
1410 <p>HSLTransform() converts a (hue, saturation, lightness) to a (red, green, blue) triple.</p></ol>
1411
1412 <p>The format of the HSLTransformImage method is:</p>
1413
1414 <pre class="code">
1415   void HSLTransform(const double hue,const double saturation,
1416     const double lightness,Quantum *red,Quantum *green,Quantum *blue)
1417 </pre>
1418
1419 <p>A description of each parameter follows:</p></ol>
1420
1421 <h5>hue, saturation, lightness</h5>
1422 <ol><p>A double value representing a component of the HSL color space.</p></ol>
1423
1424 <h5>red, green, blue</h5>
1425 <ol><p>A pointer to a pixel component of type Quantum.</p></ol>
1426
1427  </div>
1428 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1429 _8c.html" target="source" name="IdentityAffine">IdentityAffine</a></h2>
1430 <div class="doc-section">
1431
1432 <p>IdentityAffine() initializes the affine transform to the identity matrix.</p></ol>
1433
1434 <p>The format of the IdentityAffine method is:</p>
1435
1436 <pre class="code">
1437   IdentityAffine(AffineMatrix *affine)
1438 </pre>
1439
1440 <p>A description of each parameter follows:</p></ol>
1441
1442 <h5>affine</h5>
1443 <ol><p>A pointer the affine transform of type AffineMatrix.</p></ol>
1444
1445  </div>
1446 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1447 _8c.html" target="source" name="InitializeMagick">InitializeMagick</a></h2>
1448 <div class="doc-section">
1449
1450 <p>InitializeMagick() initializes the ImageMagick environment.</p></ol>
1451
1452 <p>The format of the InitializeMagick function is:</p>
1453
1454 <pre class="text">
1455   InitializeMagick(const char *path)
1456 </pre>
1457
1458 <p>A description of each parameter follows:</p></ol>
1459
1460 <h5>path</h5>
1461 <ol><p>the execution path of the current ImageMagick client.</p></ol>
1462
1463  </div>
1464 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1465 _8c.html" target="source" name="InterpolatePixelColor">InterpolatePixelColor</a></h2>
1466 <div class="doc-section">
1467
1468 <p>InterpolatePixelColor() applies bi-linear or tri-linear interpolation between a pixel and it's neighbors.</p></ol>
1469
1470 <p>The format of the InterpolatePixelColor method is:</p>
1471
1472 <pre class="code">
1473   MagickPixelPacket InterpolatePixelColor(const Image *image,
1474     CacheView *view_info,InterpolatePixelMethod method,const double x,
1475     const double y,ExceptionInfo *exception)
1476 </pre>
1477
1478 <p>A description of each parameter follows:</p></ol>
1479
1480 <h5>image</h5>
1481 <ol><p>the image.</p></ol>
1482
1483 <h5>image_view</h5>
1484 <ol><p>the image cache view.</p></ol>
1485
1486 <h5>type</h5>
1487 <ol><p>the type of pixel color interpolation.</p></ol>
1488
1489 <h5>x,y</h5>
1490 <ol><p>A double representing the current (x,y) position of the pixel.</p></ol>
1491
1492 <h5>exception</h5>
1493 <ol><p>return any errors or warnings in this structure.</p></ol>
1494
1495  </div>
1496 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1497 _8c.html" target="source" name="InterpretImageAttributes">InterpretImageAttributes</a></h2>
1498 <div class="doc-section">
1499
1500 <p>InterpretImageAttributes() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
1501
1502 <p>The format of the InterpretImageAttributes method is:</p>
1503
1504 <pre class="code">
1505   char *InterpretImageAttributes(const ImageInfo *image_info,Image *image,
1506     const char *embed_text)
1507 </pre>
1508
1509 <p>A description of each parameter follows:</p></ol>
1510
1511 <h5>image_info</h5>
1512 <ol><p>the image info.</p></ol>
1513
1514 <h5>image</h5>
1515 <ol><p>the image.</p></ol>
1516
1517 <h5>embed_text</h5>
1518 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
1519
1520  </div>
1521 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1522 _8c.html" target="source" name="LiberateMemory">LiberateMemory</a></h2>
1523 <div class="doc-section">
1524
1525 <p>LiberateMemory() frees memory that has already been allocated, and NULL's the pointer to it.</p></ol>
1526
1527 <p>The format of the LiberateMemory method is:</p>
1528
1529 <pre class="code">
1530   void LiberateMemory(void **memory)
1531 </pre>
1532
1533 <p>A description of each parameter follows:</p></ol>
1534
1535 <h5>memory</h5>
1536 <ol><p>A pointer to a block of memory to free for reuse.</p></ol>
1537
1538  </div>
1539 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1540 _8c.html" target="source" name="LiberateSemaphoreInfo">LiberateSemaphoreInfo</a></h2>
1541 <div class="doc-section">
1542
1543 <p>LiberateSemaphoreInfo() relinquishes a semaphore.</p></ol>
1544
1545 <p>The format of the LiberateSemaphoreInfo method is:</p>
1546
1547 <pre class="code">
1548   LiberateSemaphoreInfo(void **semaphore_info)
1549 </pre>
1550
1551 <p>A description of each parameter follows:</p></ol>
1552
1553 <h5>semaphore_info</h5>
1554 <ol><p>Specifies a pointer to an SemaphoreInfo structure.</p></ol>
1555
1556  </div>
1557 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1558 _8c.html" target="source" name="MagickIncarnate">MagickIncarnate</a></h2>
1559 <div class="doc-section">
1560
1561 <p>MagickIncarnate() initializes the ImageMagick environment.</p></ol>
1562
1563 <p>The format of the MagickIncarnate function is:</p>
1564
1565 <pre class="text">
1566   MagickIncarnate(const char *path)
1567 </pre>
1568
1569 <p>A description of each parameter follows:</p></ol>
1570
1571 <h5>path</h5>
1572 <ol><p>the execution path of the current ImageMagick client.</p></ol>
1573
1574  </div>
1575 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1576 _8c.html" target="source" name="MagickMonitor">MagickMonitor</a></h2>
1577 <div class="doc-section">
1578
1579 <p>MagickMonitor() calls the monitor handler method with a text string that describes the task and a measure of completion.  The method returns MagickTrue on success otherwise MagickFalse if an error is encountered, e.g. if there was a user interrupt.</p></ol>
1580
1581 <p>The format of the MagickMonitor method is:</p>
1582
1583 <pre class="code">
1584   MagickBooleanType MagickMonitor(const char *text,
1585     const MagickOffsetType offset,const MagickSizeType span,
1586     void *client_data)
1587 </pre>
1588
1589 <p>A description of each parameter follows:</p></ol>
1590
1591 <h5>offset</h5>
1592 <ol><p>the position relative to the span parameter which represents how much progress has been made toward completing a task.</p></ol>
1593
1594 <h5>span</h5>
1595 <ol><p>the span relative to completing a task.</p></ol>
1596
1597 <h5>client_data</h5>
1598 <ol><p>the client data.</p></ol>
1599
1600  </div>
1601 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1602 _8c.html" target="source" name="MapImage">MapImage</a></h2>
1603 <div class="doc-section">
1604
1605 <p>MapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
1606
1607 <p>The format of the MapImage method is:</p>
1608
1609 <pre class="code">
1610   MagickBooleanType MapImage(Image *image,const Image *map_image,
1611     const MagickBooleanType dither)
1612 </pre>
1613
1614 <p>A description of each parameter follows:</p></ol>
1615
1616 <h5>image</h5>
1617 <ol><p>Specifies a pointer to an Image structure.</p></ol>
1618
1619 <h5>map_image</h5>
1620 <ol><p>the image.  Reduce image to a set of colors represented by this image.</p></ol>
1621
1622 <h5>dither</h5>
1623 <ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
1624
1625  </div>
1626 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1627 _8c.html" target="source" name="MapImages">MapImages</a></h2>
1628 <div class="doc-section">
1629
1630 <p>MapImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
1631
1632 <p>The format of the MapImage method is:</p>
1633
1634 <pre class="code">
1635   MagickBooleanType MapImages(Image *images,Image *map_image,
1636     const MagickBooleanType dither)
1637 </pre>
1638
1639 <p>A description of each parameter follows:</p></ol>
1640
1641 <h5>image</h5>
1642 <ol><p>Specifies a pointer to a set of Image structures.</p></ol>
1643
1644 <h5>map_image</h5>
1645 <ol><p>the image.  Reduce image to a set of colors represented by this image.</p></ol>
1646
1647 <h5>dither</h5>
1648 <ol><p>Set this integer value to something other than zero to dither the quantized image.</p></ol>
1649
1650  </div>
1651 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1652 _8c.html" target="source" name="MatteFloodfill">MatteFloodfill</a></h2>
1653 <div class="doc-section">
1654
1655 <p>MatteFloodfill() changes the transparency value of any pixel that matches target and is an immediate neighbor.  If the method FillToBorderMethod is specified, the transparency value is changed for any neighbor pixel that does not match the bordercolor member of image.</p></ol>
1656
1657 <p>By default target must match a particular pixel transparency exactly. However, in many cases two transparency values may differ by a small amount.  The fuzz member of image defines how much tolerance is acceptable to consider two transparency values as the same.  For example, set fuzz to 10 and the opacity values of 100 and 102 respectively are now interpreted as the same value for the purposes of the floodfill.</p></ol>
1658
1659 <p>The format of the MatteFloodfillImage method is:</p>
1660
1661 <pre class="code">
1662   MagickBooleanType MatteFloodfillImage(Image *image,
1663     const PixelPacket target,const Quantum opacity,const long x_offset,
1664     const long y_offset,const PaintMethod method)
1665 </pre>
1666
1667 <p>A description of each parameter follows:</p></ol>
1668
1669 <h5>image</h5>
1670 <ol><p>the image.</p></ol>
1671
1672 <h5>target</h5>
1673 <ol><p>the RGB value of the target color.</p></ol>
1674
1675 <h5>opacity</h5>
1676 <ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
1677
1678 <h5>x,y</h5>
1679 <ol><p>the starting location of the operation.</p></ol>
1680
1681 <h5>method</h5>
1682 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
1683
1684  </div>
1685 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1686 _8c.html" target="source" name="MosaicImages">MosaicImages</a></h2>
1687 <div class="doc-section">
1688
1689 <p>MosaicImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
1690
1691 <p>The format of the MosaicImage method is:</p>
1692
1693 <pre class="code">
1694   Image *MosaicImages(const Image *image,ExceptionInfo *exception)
1695 </pre>
1696
1697 <p>A description of each parameter follows:</p></ol>
1698
1699 <h5>image</h5>
1700 <ol><p>the image list to be composited together</p></ol>
1701
1702 <h5>exception</h5>
1703 <ol><p>return any errors or warnings in this structure.</p></ol>
1704
1705  </div>
1706 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1707 _8c.html" target="source" name="OpaqueImage">OpaqueImage</a></h2>
1708 <div class="doc-section">
1709
1710 <p>OpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
1711
1712 <p>By default color must match a particular pixel color exactly.  However, in many cases two colors may differ by a small amount.  Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.</p></ol>
1713
1714 <p>The format of the OpaqueImage method is:</p>
1715
1716 <pre class="code">
1717   MagickBooleanType OpaqueImage(Image *image,
1718     const PixelPacket *target,const PixelPacket fill)
1719 </pre>
1720
1721 <p>A description of each parameter follows:</p></ol>
1722
1723 <h5>image</h5>
1724 <ol><p>the image.</p></ol>
1725
1726 <h5>target</h5>
1727 <ol><p>the RGB value of the target color.</p></ol>
1728
1729 <h5>fill</h5>
1730 <ol><p>the replacement color.</p></ol>
1731
1732  </div>
1733 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1734 _8c.html" target="source" name="OpenCacheView">OpenCacheView</a></h2>
1735 <div class="doc-section">
1736
1737 <p>OpenCacheView() opens a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
1738
1739 <p>The format of the OpenCacheView method is:</p>
1740
1741 <pre class="code">
1742   CacheView *OpenCacheView(const Image *image)
1743 </pre>
1744
1745 <p>A description of each parameter follows:</p></ol>
1746
1747 <h5>image</h5>
1748 <ol><p>the image.</p></ol>
1749
1750  </div>
1751 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1752 _8c.html" target="source" name="PaintFloodfill">PaintFloodfill</a></h2>
1753 <div class="doc-section">
1754
1755 <p>PaintFloodfill() changes the color value of any pixel that matches target and is an immediate neighbor.  If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.</p></ol>
1756
1757 <p>By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount.  The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same.  For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.</p></ol>
1758
1759 <p>The format of the PaintFloodfillImage method is:</p>
1760
1761 <pre class="code">
1762   MagickBooleanType PaintFloodfillImage(Image *image,
1763     const ChannelType channel,const MagickPixelPacket target,const long x,
1764     const long y,const DrawInfo *draw_info,const PaintMethod method)
1765 </pre>
1766
1767 <p>A description of each parameter follows:</p></ol>
1768
1769 <h5>image</h5>
1770 <ol><p>the image.</p></ol>
1771
1772 <h5>channel</h5>
1773 <ol><p>the channel(s).</p></ol>
1774
1775 <h5>target</h5>
1776 <ol><p>the RGB value of the target color.</p></ol>
1777
1778 <h5>x,y</h5>
1779 <ol><p>the starting location of the operation.</p></ol>
1780
1781 <h5>draw_info</h5>
1782 <ol><p>the draw info.</p></ol>
1783
1784 <h5>method</h5>
1785 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
1786
1787  </div>
1788 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1789 _8c.html" target="source" name="PaintOpaqueImage">PaintOpaqueImage</a></h2>
1790 <div class="doc-section">
1791
1792 <p>PaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
1793
1794 <p>By default color must match a particular pixel color exactly.  However, in many cases two colors may differ by a small amount.  Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.</p></ol>
1795
1796 <p>The format of the PaintOpaqueImage method is:</p>
1797
1798 <pre class="code">
1799   MagickBooleanType PaintOpaqueImage(Image *image,
1800     const PixelPacket *target,const PixelPacket *fill)
1801   MagickBooleanType PaintOpaqueImageChannel(Image *image,
1802     const ChannelType channel,const PixelPacket *target,
1803     const PixelPacket *fill)
1804 </pre>
1805
1806 <p>A description of each parameter follows:</p></ol>
1807
1808 <h5>image</h5>
1809 <ol><p>the image.</p></ol>
1810
1811 <h5>channel</h5>
1812 <ol><p>the channel(s).</p></ol>
1813
1814 <h5>target</h5>
1815 <ol><p>the RGB value of the target color.</p></ol>
1816
1817 <h5>fill</h5>
1818 <ol><p>the replacement color.</p></ol>
1819
1820  </div>
1821 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1822 _8c.html" target="source" name="PaintTransparentImage">PaintTransparentImage</a></h2>
1823 <div class="doc-section">
1824
1825 <p>PaintTransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
1826
1827 <p>By default color must match a particular pixel color exactly.  However, in many cases two colors may differ by a small amount.  Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.</p></ol>
1828
1829 <p>The format of the PaintTransparentImage method is:</p>
1830
1831 <pre class="code">
1832   MagickBooleanType PaintTransparentImage(Image *image,
1833     const MagickPixelPacket *target,const Quantum opacity)
1834 </pre>
1835
1836 <p>A description of each parameter follows:</p></ol>
1837
1838 <h5>image</h5>
1839 <ol><p>the image.</p></ol>
1840
1841 <h5>target</h5>
1842 <ol><p>the RGB value of the target color.</p></ol>
1843
1844 <h5>opacity</h5>
1845 <ol><p>the replacement opacity value.</p></ol>
1846
1847  </div>
1848 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1849 _8c.html" target="source" name="ParseSizeGeometry">ParseSizeGeometry</a></h2>
1850 <div class="doc-section">
1851
1852 <p>ParseSizeGeometry() returns a region as defined by the geometry string with respect to the image dimensions and aspect ratio.</p></ol>
1853
1854 <p>The format of the ParseSizeGeometry method is:</p>
1855
1856 <pre class="code">
1857   MagickStatusType ParseSizeGeometry(const Image *image,
1858     const char *geometry,RectangeInfo *region_info)
1859 </pre>
1860
1861 <p>A description of each parameter follows:</p></ol>
1862
1863 <h5>geometry</h5>
1864 <ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
1865
1866 <h5>region_info</h5>
1867 <ol><p>the region as defined by the geometry string.</p></ol>
1868
1869  </div>
1870 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1871 _8c.html" target="source" name="PopImageList">PopImageList</a></h2>
1872 <div class="doc-section">
1873
1874 <p>PopImageList() removes the last image in the list.</p></ol>
1875
1876 <p>The format of the PopImageList method is:</p>
1877
1878 <pre class="code">
1879   Image *PopImageList(Image **images)
1880 </pre>
1881
1882 <p>A description of each parameter follows:</p></ol>
1883
1884 <h5>images</h5>
1885 <ol><p>the image list.</p></ol>
1886
1887  </div>
1888 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1889 _8c.html" target="source" name="PopImagePixels">PopImagePixels</a></h2>
1890 <div class="doc-section">
1891
1892 <p>PopImagePixels() transfers one or more pixel components from the image pixel cache to a user supplied buffer.  The pixels are returned in network byte order.  MagickTrue is returned if the pixels are successfully transferred, otherwise MagickFalse.</p></ol>
1893
1894 <p>The format of the PopImagePixels method is:</p>
1895
1896 <pre class="code">
1897   size_t PopImagePixels(Image *,const QuantumType quantum,
1898     unsigned char *destination)
1899 </pre>
1900
1901 <p>A description of each parameter follows:</p></ol>
1902
1903 <h5>image</h5>
1904 <ol><p>the image.</p></ol>
1905
1906 <h5>quantum</h5>
1907 <ol><p>Declare which pixel components to transfer (RGB, RGBA, etc).</p></ol>
1908
1909 <h5>destination</h5>
1910 <ol><p>The components are transferred to this buffer.</p></ol>
1911
1912  </div>
1913 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1914 _8c.html" target="source" name="PostscriptGeometry">PostscriptGeometry</a></h2>
1915 <div class="doc-section">
1916
1917 <p>PostscriptGeometry() replaces any page mneumonic with the equivalent size in picas.</p></ol>
1918
1919 <p>The format of the PostscriptGeometry method is:</p>
1920
1921 <pre class="code">
1922   char *PostscriptGeometry(const char *page)
1923 </pre>
1924
1925 <p>A description of each parameter follows.</p></ol>
1926
1927 <h5> page</h5>
1928 <ol><p>Specifies a pointer to an array of characters. The string is either a Postscript page name (e.g. A4) or a postscript page geometry (e.g. 612x792+36+36).</p></ol>
1929
1930  </div>
1931 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1932 _8c.html" target="source" name="PushImageList">PushImageList</a></h2>
1933 <div class="doc-section">
1934
1935 <p>PushImageList() adds an image to the end of the list.</p></ol>
1936
1937 <p>The format of the PushImageList method is:</p>
1938
1939 <pre class="code">
1940   unsigned int PushImageList(Image *images,const Image *image,
1941     ExceptionInfo *exception)
1942 </pre>
1943
1944 <p>A description of each parameter follows:</p></ol>
1945
1946 <h5>images</h5>
1947 <ol><p>the image list.</p></ol>
1948
1949 <h5>image</h5>
1950 <ol><p>the image.</p></ol>
1951
1952 <h5>exception</h5>
1953 <ol><p>return any errors or warnings in this structure.</p></ol>
1954
1955  </div>
1956 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1957 _8c.html" target="source" name="PushImagePixels">PushImagePixels</a></h2>
1958 <div class="doc-section">
1959
1960 <p>PushImagePixels() transfers one or more pixel components from a user supplied buffer into the image pixel cache of an image.  The pixels are expected in network byte order.  It returns MagickTrue if the pixels are successfully transferred, otherwise MagickFalse.</p></ol>
1961
1962 <p>The format of the PushImagePixels method is:</p>
1963
1964 <pre class="code">
1965   size_t PushImagePixels(Image *image,const QuantumType quantum,
1966     const unsigned char *source)
1967 </pre>
1968
1969 <p>A description of each parameter follows:</p></ol>
1970
1971 <h5>image</h5>
1972 <ol><p>the image.</p></ol>
1973
1974 <h5>quantum</h5>
1975 <ol><p>Declare which pixel components to transfer (red, green, blue, opacity, RGB, or RGBA).</p></ol>
1976
1977 <h5>source</h5>
1978 <ol><p>The pixel components are transferred from this buffer.</p></ol>
1979
1980  </div>
1981 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1982 _8c.html" target="source" name="QuantizationError">QuantizationError</a></h2>
1983 <div class="doc-section">
1984
1985 <p>QuantizationError() measures the difference between the original and quantized images.  This difference is the total quantization error.  The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value.  These values are computed:</p>
1986
1987 <pre class="text">
1988       o mean_error_per_pixel:  This value is the mean error for any single
1989   pixel in the image.
1990 </pre>
1991
1992 <h5>normalized_mean_square_error</h5>
1993 <ol><p>This value is the normalized mean quantization error for any single pixel in the image.  This distance measure is normalized to a range between 0 and 1.  It is independent of the range of red, green, and blue values in the image.</p></ol>
1994
1995 <h5>normalized_maximum_square_error</h5>
1996 <ol><p>Thsi value is the normalized maximum quantization error for any single pixel in the image.  This distance measure is normalized to a range between 0 and 1.  It is independent of the range of red, green, and blue values in your image.</p></ol>
1997
1998
1999 <p>The format of the QuantizationError method is:</p>
2000
2001 <pre class="code">
2002   unsigned int QuantizationError(Image *image)
2003 </pre>
2004
2005 <p>A description of each parameter follows.</p></ol>
2006
2007 <h5>image</h5>
2008 <ol><p>Specifies a pointer to an Image structure;  returned from ReadImage.</p></ol>
2009
2010  </div>
2011 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2012 _8c.html" target="source" name="RandomChannelThresholdImage">RandomChannelThresholdImage</a></h2>
2013 <div class="doc-section">
2014
2015 <p>RandomChannelThresholdImage() changes the value of individual pixels based on the intensity of each pixel compared to a random threshold.  The result is a low-contrast, two color image.</p></ol>
2016
2017 <p>The format of the RandomChannelThresholdImage method is:</p>
2018
2019 <pre class="code">
2020   unsigned int RandomChannelThresholdImage(Image *image,
2021      const char *channel, const char *thresholds,
2022      ExceptionInfo *exception)
2023 </pre>
2024
2025 <p>A description of each parameter follows:</p></ol>
2026
2027 <h5>image</h5>
2028 <ol><p>the image.</p></ol>
2029
2030 <h5>channel</h5>
2031 <ol><p>the channel or channels to be thresholded.</p></ol>
2032
2033 <h5>thresholds</h5>
2034 <ol><p>a geometry string containing LOWxHIGH thresholds. If the string contains 2x2, 3x3, or 4x4, then an ordered dither of order 2, 3, or 4 will be performed instead.</p></ol>
2035
2036 <h5>exception</h5>
2037 <ol><p>return any errors or warnings in this structure.</p></ol>
2038
2039  </div>
2040 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2041 _8c.html" target="source" name="ReacquireMemory">ReacquireMemory</a></h2>
2042 <div class="doc-section">
2043
2044 <p>ReacquireMemory() changes the size of the memory and returns a pointer to the (possibly moved) block.  The contents will be unchanged up to the lesser of the new and old sizes.</p></ol>
2045
2046 <p>The format of the ReacquireMemory method is:</p>
2047
2048 <pre class="code">
2049   void ReacquireMemory(void **memory,const size_t size)
2050 </pre>
2051
2052 <p>A description of each parameter follows:</p></ol>
2053
2054 <h5>memory</h5>
2055 <ol><p>A pointer to a memory allocation.  On return the pointer may change but the contents of the original allocation will not.</p></ol>
2056
2057 <h5>size</h5>
2058 <ol><p>the new size of the allocated memory.</p></ol>
2059
2060  </div>
2061 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2062 _8c.html" target="source" name="ResetImageAttributeIterator">ResetImageAttributeIterator</a></h2>
2063 <div class="doc-section">
2064
2065 <p>ResetImageAttributeIterator() resets the image attributes iterator.  Use it in conjunction with GetNextImageAttribute() to iterate over all the values associated with an image.</p></ol>
2066
2067 <p>The format of the ResetImageAttributeIterator method is:</p>
2068
2069 <pre class="code">
2070   ResetImageAttributeIterator(const ImageInfo *image)
2071 </pre>
2072
2073 <p>A description of each parameter follows:</p></ol>
2074
2075 <h5>image</h5>
2076 <ol><p>the image.</p></ol>
2077
2078  </div>
2079 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2080 _8c.html" target="source" name="SetCacheViewPixels">SetCacheViewPixels</a></h2>
2081 <div class="doc-section">
2082
2083 <p>SetCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters.   A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
2084
2085 <p>The format of the SetCacheViewPixels method is:</p>
2086
2087 <pre class="code">
2088   PixelPacket *SetCacheViewPixels(CacheView *cache_view,const long x,
2089     const long y,const unsigned long columns,const unsigned long rows)
2090 </pre>
2091
2092 <p>A description of each parameter follows:</p></ol>
2093
2094 <h5>cache_view</h5>
2095 <ol><p>the cache view.</p></ol>
2096
2097 <h5>x,y,columns,rows</h5>
2098 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
2099
2100  </div>
2101 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2102 _8c.html" target="source" name="SetExceptionInfo">SetExceptionInfo</a></h2>
2103 <div class="doc-section">
2104
2105 <p>SetExceptionInfo() sets the exception severity.</p></ol>
2106
2107 <p>The format of the SetExceptionInfo method is:</p>
2108
2109 <pre class="code">
2110   MagickBooleanType SetExceptionInfo(ExceptionInfo *exception,
2111     ExceptionType severity)
2112 </pre>
2113
2114 <p>A description of each parameter follows:</p></ol>
2115
2116 <h5>exception</h5>
2117 <ol><p>the exception info.</p></ol>
2118
2119 <h5>severity</h5>
2120 <ol><p>the exception severity.</p></ol>
2121
2122  </div>
2123 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2124 _8c.html" target="source" name="SetImage">SetImage</a></h2>
2125 <div class="doc-section">
2126
2127 <p>SetImage() sets the red, green, and blue components of each pixel to the image background color and the opacity component to the specified level of transparency.  The background color is defined by the background_color member of the image.</p></ol>
2128
2129 <p>The format of the SetImage method is:</p>
2130
2131 <pre class="code">
2132   void SetImage(Image *image,const Quantum opacity)
2133 </pre>
2134
2135 <p>A description of each parameter follows:</p></ol>
2136
2137 <h5>image</h5>
2138 <ol><p>the image.</p></ol>
2139
2140 <h5>opacity</h5>
2141 <ol><p>Set each pixel to this level of transparency.</p></ol>
2142
2143  </div>
2144 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2145 _8c.html" target="source" name="SetImageAttribute">SetImageAttribute</a></h2>
2146 <div class="doc-section">
2147
2148 <p>SetImageAttribute() searches the list of image attributes and replaces the attribute value.  If it is not found in the list, the attribute name and value is added to the list.   </p></ol>
2149
2150 <p>The format of the SetImageAttribute method is:</p>
2151
2152 <pre class="code">
2153    MagickBooleanType SetImageAttribute(Image *image,const char *key,
2154      const char *value)
2155 </pre>
2156
2157 <p>A description of each parameter follows:</p></ol>
2158
2159 <h5>image</h5>
2160 <ol><p>the image.</p></ol>
2161
2162 <h5>key</h5>
2163 <ol><p>the key.</p></ol>
2164
2165 <h5>value</h5>
2166 <ol><p>the value.</p></ol>
2167
2168  </div>
2169 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2170 _8c.html" target="source" name="SetImageList">SetImageList</a></h2>
2171 <div class="doc-section">
2172
2173 <p>SetImageList() inserts an image into the list at the specified position.</p></ol>
2174
2175 <p>The format of the SetImageList method is:</p>
2176
2177 <pre class="code">
2178   unsigned int SetImageList(Image *images,const Image *image,
2179     const long offset,ExceptionInfo *exception)
2180 </pre>
2181
2182 <p>A description of each parameter follows:</p></ol>
2183
2184 <h5>images</h5>
2185 <ol><p>the image list.</p></ol>
2186
2187 <h5>image</h5>
2188 <ol><p>the image.</p></ol>
2189
2190 <h5>offset</h5>
2191 <ol><p>the position within the list.</p></ol>
2192
2193 <h5>exception</h5>
2194 <ol><p>return any errors or warnings in this structure.</p></ol>
2195
2196  </div>
2197 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2198 _8c.html" target="source" name="SetImagePixels">SetImagePixels</a></h2>
2199 <div class="doc-section">
2200
2201 <p>SetImagePixels() queues a mutable pixel region. If the region is successfully intialized a pointer to a PixelPacket array representing the region is returned, otherwise NULL is returned. The returned pointer may point to a temporary working buffer for the pixels or it may point to the final location of the pixels in memory.</p></ol>
2202
2203 <p>Write-only access means that any existing pixel values corresponding to the region are ignored.  This useful while the initial image is being created from scratch, or if the existing pixel values are to be completely replaced without need to refer to their pre-existing values. The application is free to read and write the pixel buffer returned by SetImagePixels() any way it pleases. SetImagePixels() does not initialize the pixel array values. Initializing pixel array values is the application's responsibility.</p></ol>
2204
2205 <p>Performance is maximized if the selected region is part of one row, or one or more full rows, since then there is opportunity to access the pixels in-place (without a copy) if the image is in RAM, or in a memory-mapped file. The returned pointer should *never* be deallocated by the user.</p></ol>
2206
2207 <p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to obtain the black color component or the colormap indexes (of type IndexPacket) corresponding to the region.  Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.</p></ol>
2208
2209 <p>The format of the SetImagePixels() method is:</p>
2210
2211 <pre class="code">
2212   PixelPacket *SetImagePixels(Image *image,const long x,const long y,
2213     const unsigned long columns,const unsigned long rows)
2214 </pre>
2215
2216 <p>A description of each parameter follows:</p></ol>
2217
2218 <h5>pixels</h5>
2219 <ol><p>SetImagePixels returns a pointer to the pixels if they are transferred, otherwise a NULL is returned.</p></ol>
2220
2221 <h5>image</h5>
2222 <ol><p>the image.</p></ol>
2223
2224 <h5>x,y,columns,rows</h5>
2225 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
2226
2227  </div>
2228 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2229 _8c.html" target="source" name="SetMagickRegistry">SetMagickRegistry</a></h2>
2230 <div class="doc-section">
2231
2232 <p>SetMagickRegistry() sets a blob into the registry and returns a unique ID. If an error occurs, -1 is returned.</p></ol>
2233
2234 <p>The format of the SetMagickRegistry method is:</p>
2235
2236 <pre class="code">
2237   long SetMagickRegistry(const RegistryType type,const void *blob,
2238     const size_t length,ExceptionInfo *exception)
2239 </pre>
2240
2241 <p>A description of each parameter follows:</p></ol>
2242
2243 <h5>type</h5>
2244 <ol><p>the registry type.</p></ol>
2245
2246 <h5>blob</h5>
2247 <ol><p>the address of a Binary Large OBject.</p></ol>
2248
2249 <h5>length</h5>
2250 <ol><p>For a registry type of ImageRegistryType use sizeof(Image) otherise the blob length in number of bytes.</p></ol>
2251
2252 <h5>exception</h5>
2253 <ol><p>return any errors or warnings in this structure.</p></ol>
2254
2255  </div>
2256 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2257 _8c.html" target="source" name="SetMonitorHandler">SetMonitorHandler</a></h2>
2258 <div class="doc-section">
2259
2260 <p>SetMonitorHandler() sets the monitor handler to the specified method and returns the previous monitor handler.</p></ol>
2261
2262 <p>The format of the SetMonitorHandler method is:</p>
2263
2264 <pre class="code">
2265   MonitorHandler SetMonitorHandler(MonitorHandler handler)
2266 </pre>
2267
2268 <p>A description of each parameter follows:</p></ol>
2269
2270 <h5>handler</h5>
2271 <ol><p>Specifies a pointer to a method to handle monitors.</p></ol>
2272
2273  </div>
2274 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2275 _8c.html" target="source" name="ShiftImageList">ShiftImageList</a></h2>
2276 <div class="doc-section">
2277
2278 <p>ShiftImageList() removes an image from the beginning of the list.</p></ol>
2279
2280 <p>The format of the ShiftImageList method is:</p>
2281
2282 <pre class="code">
2283   Image *ShiftImageList(Image **images)
2284 </pre>
2285
2286 <p>A description of each parameter follows:</p></ol>
2287
2288 <h5>images</h5>
2289 <ol><p>the image list.</p></ol>
2290
2291  </div>
2292 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2293 _8c.html" target="source" name="SpliceImageList">SpliceImageList</a></h2>
2294 <div class="doc-section">
2295
2296 <p>SpliceImageList() removes the images designated by offset and length from the list and replaces them with the specified list.</p></ol>
2297
2298 <p>The format of the SpliceImageList method is:</p>
2299
2300 <pre class="code">
2301   Image *SpliceImageList(Image *images,const long offset,
2302     const unsigned long length,const Image *splices,
2303     ExceptionInfo *exception)
2304 </pre>
2305
2306 <p>A description of each parameter follows:</p></ol>
2307
2308 <h5>images</h5>
2309 <ol><p>the image list.</p></ol>
2310
2311 <h5>offset</h5>
2312 <ol><p>the position within the list.</p></ol>
2313
2314 <h5>length</h5>
2315 <ol><p>the length of the image list to remove.</p></ol>
2316
2317 <h5>splice</h5>
2318 <ol><p>Replace the removed image list with this list.</p></ol>
2319
2320 <h5>exception</h5>
2321 <ol><p>return any errors or warnings in this structure.</p></ol>
2322
2323  </div>
2324 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2325 _8c.html" target="source" name="Strip">Strip</a></h2>
2326 <div class="doc-section">
2327
2328 <p>Strip() strips any whitespace or quotes from the beginning and end of a string of characters.</p></ol>
2329
2330 <p>The format of the Strip method is:</p>
2331
2332 <pre class="code">
2333   void Strip(char *message)
2334 </pre>
2335
2336 <p>A description of each parameter follows:</p></ol>
2337
2338 <h5>message</h5>
2339 <ol><p>Specifies an array of characters.</p></ol>
2340
2341  </div>
2342 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2343 _8c.html" target="source" name="SyncCacheView">SyncCacheView</a></h2>
2344 <div class="doc-section">
2345
2346 <p>SyncCacheView() saves the cache view pixels to the in-memory or disk cache.  It returns MagickTrue if the pixel region is synced, otherwise MagickFalse.</p></ol>
2347
2348 <p>The format of the SyncCacheView method is:</p>
2349
2350 <pre class="code">
2351   MagickBooleanType SyncCacheView(CacheView *cache_view)
2352 </pre>
2353
2354 <p>A description of each parameter follows:</p></ol>
2355
2356 <h5>cache_view</h5>
2357 <ol><p>the cache view.</p></ol>
2358
2359  </div>
2360 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2361 _8c.html" target="source" name="SyncCacheViewPixels">SyncCacheViewPixels</a></h2>
2362 <div class="doc-section">
2363
2364 <p>SyncCacheViewPixels() saves the cache view pixels to the in-memory or disk cache.  It returns MagickTrue if the pixel region is flushed, otherwise MagickFalse.</p></ol>
2365
2366 <p>The format of the SyncCacheViewPixels method is:</p>
2367
2368 <pre class="code">
2369   MagickBooleanType SyncCacheViewPixels(CacheView *cache_view)
2370 </pre>
2371
2372 <p>A description of each parameter follows:</p></ol>
2373
2374 <h5>cache_view</h5>
2375 <ol><p>the cache view.</p></ol>
2376
2377 <h5>exception</h5>
2378 <ol><p>return any errors or warnings in this structure.</p></ol>
2379
2380  </div>
2381 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2382 _8c.html" target="source" name="SyncImagePixels">SyncImagePixels</a></h2>
2383 <div class="doc-section">
2384
2385 <p>SyncImagePixels() saves the image pixels to the in-memory or disk cache. The method returns MagickTrue if the pixel region is synced, otherwise MagickFalse.</p></ol>
2386
2387 <p>The format of the SyncImagePixels() method is:</p>
2388
2389 <pre class="code">
2390   MagickBooleanType SyncImagePixels(Image *image)
2391 </pre>
2392
2393 <p>A description of each parameter follows:</p></ol>
2394
2395 <h5>image</h5>
2396 <ol><p>the image.</p></ol>
2397
2398  </div>
2399 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2400 _8c.html" target="source" name="TemporaryFilename">TemporaryFilename</a></h2>
2401 <div class="doc-section">
2402
2403 <p>TemporaryFilename() replaces the contents of path by a unique path name.</p></ol>
2404
2405 <p>The format of the TemporaryFilename method is:</p>
2406
2407 <pre class="code">
2408   void TemporaryFilename(char *path)
2409 </pre>
2410
2411 <p>A description of each parameter follows.</p></ol>
2412
2413 <h5> path</h5>
2414 <ol><p>Specifies a pointer to an array of characters.  The unique path name is returned in this array.</p></ol>
2415
2416  </div>
2417 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2418 _8c.html" target="source" name="ThresholdImage">ThresholdImage</a></h2>
2419 <div class="doc-section">
2420
2421 <p>ThresholdImage() changes the value of individual pixels based on the intensity of each pixel compared to threshold.  The result is a high-contrast, two color image.</p></ol>
2422
2423 <p>The format of the ThresholdImage method is:</p>
2424
2425 <pre class="code">
2426   unsigned int ThresholdImage(Image *image,const double threshold)
2427 </pre>
2428
2429 <p>A description of each parameter follows:</p></ol>
2430
2431 <h5>image</h5>
2432 <ol><p>the image.</p></ol>
2433
2434 <h5>threshold</h5>
2435 <ol><p>Define the threshold value</p></ol>
2436
2437  </div>
2438 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2439 _8c.html" target="source" name="ThresholdImageChannel">ThresholdImageChannel</a></h2>
2440 <div class="doc-section">
2441
2442 <p>ThresholdImageChannel() changes the value of individual pixels based on the intensity of each pixel channel.  The result is a high-contrast image.</p></ol>
2443
2444 <p>The format of the ThresholdImageChannel method is:</p>
2445
2446 <pre class="code">
2447   unsigned int ThresholdImageChannel(Image *image,const char *threshold)
2448 </pre>
2449
2450 <p>A description of each parameter follows:</p></ol>
2451
2452 <h5>image</h5>
2453 <ol><p>the image.</p></ol>
2454
2455 <h5>threshold</h5>
2456 <ol><p>define the threshold values.</p></ol>
2457
2458  </div>
2459 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2460 _8c.html" target="source" name="TransformHSL">TransformHSL</a></h2>
2461 <div class="doc-section">
2462
2463 <p>TransformHSL() converts a (red, green, blue) to a (hue, saturation, lightness) triple.</p></ol>
2464
2465 <p>The format of the TransformHSL method is:</p>
2466
2467 <pre class="code">
2468   void TransformHSL(const Quantum red,const Quantum green,
2469     const Quantum blue,double *hue,double *saturation,double *lightness)
2470 </pre>
2471
2472 <p>A description of each parameter follows:</p></ol>
2473
2474 <h5>red, green, blue</h5>
2475 <ol><p>A Quantum value representing the red, green, and blue component of a pixel..</p></ol>
2476
2477 <h5>hue, saturation, lightness</h5>
2478 <ol><p>A pointer to a double value representing a component of the HSL color space.</p></ol>
2479
2480  </div>
2481 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2482 _8c.html" target="source" name="TranslateText">TranslateText</a></h2>
2483 <div class="doc-section">
2484
2485 <p>TranslateText() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
2486
2487 <p>The format of the TranslateText method is:</p>
2488
2489 <pre class="code">
2490   char *TranslateText(const ImageInfo *image_info,Image *image,
2491     const char *embed_text)
2492 </pre>
2493
2494 <p>A description of each parameter follows:</p></ol>
2495
2496 <h5>image_info</h5>
2497 <ol><p>the image info.</p></ol>
2498
2499 <h5>image</h5>
2500 <ol><p>the image.</p></ol>
2501
2502 <h5>embed_text</h5>
2503 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
2504
2505  </div>
2506 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2507 _8c.html" target="source" name="TransparentImage">TransparentImage</a></h2>
2508 <div class="doc-section">
2509
2510 <p>TransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
2511
2512 <p>By default color must match a particular pixel color exactly.  However, in many cases two colors may differ by a small amount.  Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.</p></ol>
2513
2514 <p>The format of the TransparentImage method is:</p>
2515
2516 <pre class="code">
2517   MagickBooleanType TransparentImage(Image *image,
2518     const PixelPacket target,const Quantum opacity)
2519 </pre>
2520
2521 <p>A description of each parameter follows:</p></ol>
2522
2523 <h5>image</h5>
2524 <ol><p>the image.</p></ol>
2525
2526 <h5>target</h5>
2527 <ol><p>the RGB value of the target color.</p></ol>
2528
2529 <h5>opacity</h5>
2530 <ol><p>the replacement opacity value.</p></ol>
2531
2532  </div>
2533 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2534 _8c.html" target="source" name="UnshiftImageList">UnshiftImageList</a></h2>
2535 <div class="doc-section">
2536
2537 <p>UnshiftImageList() adds the image to the beginning of the list.</p></ol>
2538
2539 <p>The format of the UnshiftImageList method is:</p>
2540
2541 <pre class="code">
2542   unsigned int UnshiftImageList(Image *images,const Image *image,
2543     ExceptionInfo *exception)
2544 </pre>
2545
2546 <p>A description of each parameter follows:</p></ol>
2547
2548 <h5>images</h5>
2549 <ol><p>the image list.</p></ol>
2550
2551 <h5>image</h5>
2552 <ol><p>the image.</p></ol>
2553
2554 <h5>exception</h5>
2555 <ol><p>return any errors or warnings in this structure.</p></ol>
2556
2557  </div>
2558 \r
2559 </div>\r
2560 \r
2561 <div id="linkbar">\r
2562  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
2563     <span id="linkbar-center">\r
2564       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
2565       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
2566     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
2567     </span>\r
2568     <span id="linkbar-east">&nbsp;</span>\r
2569   </div>\r
2570   <div class="footer">\r
2571     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
2572     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
2573   </div>\r
2574   <div style="clear: both; margin: 0; width: 100%; "></div>\r
2575 </body>\r
2576 </html>\r