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" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
   7   <title>ImageMagick: MagickCore, C API for ImageMagick: Deprecated Methods</title/>
   8   <meta http-equiv="Content-Language" content="en-US"/>
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  10   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  11   <meta name="Application-name" content="ImageMagick"/>
  12   <meta name="Description" content="ImageMagick® is a software suite to create, edit, 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."/>
  13   <meta name="Application-url" content="http://www.imagemagick.org"/>
  14   <meta name="Generator" content="PHP"/>
  15   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, deprecated, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  16   <meta name="Rating" content="GENERAL"/>
  17   <meta name="Robots" content="INDEX, FOLLOW"/>
  18   <meta name="Generator" content="ImageMagick Studio LLC"/>
  19   <meta name="Author" content="ImageMagick Studio LLC"/>
  20   <meta name="Revisit-after" content="2 DAYS"/>
  21   <meta name="Resource-type" content="document"/>
  22   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../../images/wand.png"  sizes="32x32"/>
  25   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  26   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  27   <style type="text/css" media="all">\r
  28     @import url("../../www/magick.css");\r
  29   </style>\r
  30 </head>\r
  31 \r
  32 <body id="www-imagemagick-org">\r
  33 <div class="titlebar">\r
  34 <a href="../../index.html">\r
  35   <img src="../../images/script.png" alt="[ImageMagick]"\r
  36   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  37 <a href="http://www.networkredux.com">\r
  38   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  39   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  40 <a href="http://www.imagemagick.org/discourse-server/">\r
  41   <img src="../../images/logo.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 <a href="../../index.html">\r
  44   <img src="../../images/sprite.jpg" alt=""\r
  45   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  46 </div>\r
  47 \r
  48 <div class="westbar">\r
  49 \r
  50 <div class="menu">
  51   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  52 </div>
  53 <div class="sep"></div>\r
  54 <div class="menu">
  55   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  62 </div>
  63 <div class="sub">
  64     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  65 </div>
  66 <div class="sep"></div>\r
  67 <div class="menu">
  68   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  78 </div>
  79 <div class="menu">
  80   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  90 </div>
  91 <div class="sub">
  92     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  93 </div>
  94 <div class="sep"></div>\r
  95 <div  class="menu">
  96    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 103  </div>
 104 <div class="menu">
 105   <a title="Resources" href="../../www/resources.html">Resources</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 109 </div>
 110 <div class="menu">
 111   <a title="Download" href="../../www/download.html">Download</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div class="menu">
 119   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 120 </div>
 121 <div  class="sub">
 122     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 127
 128 <div class="sponsbox">
 129 <div  class="sponsor">
 130   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 146 </div>
 147 <div  class="sponsor">
 148    <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
 149 </div>
 150 </div>
 151 </div>
 152 </div>\r
 153 \r
 154 <div class="eastbar">\r
 155   <script type="text/javascript">\r
 156   <!--\r
 157     google_ad_client = "pub-3129977114552745";\r
 158     google_ad_slot = "0574824969";\r
 159     google_ad_width = 160;\r
 160     google_ad_height = 600;\r
 161   //-->\r
 162   </script>\r
 163   <script type="text/javascript"\r
 164     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 165   </script>\r
 166 </div>\r
 167 \r
 168 <div class="main">\r
 169 \r
 170 <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="#AverageImages">AverageImages</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="#LevelImageColor">LevelImageColor</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="#MaximumImages">MaximumImages</a> &bull; <a href="#MinimumImages">MinimumImages</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="#RecolorImage">RecolorImage</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>
 171
 172 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 173 _8c.html" target="source" name="AcquireCacheViewIndexes">AcquireCacheViewIndexes</a></h2>
 174 <div class="doc-section">
 175
 176 <p>AcquireCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
 177
 178 <p>Deprecated, replace with:</p>
 179
 180 <pre class="text">
 181       GetCacheViewVirtualIndexQueue(cache_view);
 182 </pre>
 183
 184 <p>The format of the AcquireCacheViewIndexes method is:</p>
 185
 186 <pre class="code">
 187   const IndexPacket *AcquireCacheViewIndexes(const CacheView *cache_view)
 188 </pre>
 189
 190 <p>A description of each parameter follows:</p></ol>
 191
 192 <h5>cache_view</h5>
 193 <ol><p>the cache view.</p></ol>
 194
 195  </div>
 196 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 197 _8c.html" target="source" name="AcquireCacheViewPixels">AcquireCacheViewPixels</a></h2>
 198 <div class="doc-section">
 199
 200 <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>
 201
 202 <p>Deprecated, replace with:</p>
 203
 204 <pre class="text">
 205       GetCacheViewVirtualPixels(cache_view,x,y,columns,rows,exception);
 206 </pre>
 207
 208 <p>The format of the AcquireCacheViewPixels method is:</p>
 209
 210 <pre class="code">
 211   const PixelPacket *AcquireCacheViewPixels(const CacheView *cache_view,
 212     const ssize_t x,const ssize_t y,const size_t columns,
 213     const size_t rows,ExceptionInfo *exception)
 214 </pre>
 215
 216 <p>A description of each parameter follows:</p></ol>
 217
 218 <h5>cache_view</h5>
 219 <ol><p>the cache view.</p></ol>
 220
 221 <h5>x,y,columns,rows</h5>
 222 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 223
 224 <h5>exception</h5>
 225 <ol><p>return any errors or warnings in this structure.</p></ol>
 226
 227  </div>
 228 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 229 _8c.html" target="source" name="AcquireImagePixels">AcquireImagePixels</a></h2>
 230 <div class="doc-section">
 231
 232 <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>
 233
 234 <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>
 235
 236 <p>If you plan to modify the pixels, use GetAuthenticPixels() instead.</p></ol>
 237
 238 <p>Note, the AcquireImagePixels() and GetAuthenticPixels() methods are not thread-safe.  In a threaded environment, use GetCacheViewVirtualPixels() or GetCacheViewAuthenticPixels() instead.</p></ol>
 239
 240 <p>Deprecated, replace with:</p>
 241
 242 <pre class="text">
 243       GetVirtualPixels(image,x,y,columns,rows,exception);
 244 </pre>
 245
 246 <p>The format of the AcquireImagePixels() method is:</p>
 247
 248 <pre class="code">
 249   const PixelPacket *AcquireImagePixels(const Image *image,const ssize_t x,
 250     const ssize_t y,const size_t columns,const size_t rows,
 251     ExceptionInfo *exception)
 252 </pre>
 253
 254 <p>A description of each parameter follows:</p></ol>
 255
 256 <h5>image</h5>
 257 <ol><p>the image.</p></ol>
 258
 259 <h5>x,y,columns,rows</h5>
 260 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 261
 262 <h5>exception</h5>
 263 <ol><p>return any errors or warnings in this structure.</p></ol>
 264
 265  </div>
 266 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 267 _8c.html" target="source" name="AcquireIndexes">AcquireIndexes</a></h2>
 268 <div class="doc-section">
 269
 270 <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>
 271
 272 <p>Deprecated, replace with:</p>
 273
 274 <pre class="text">
 275       GetVirtualIndexQueue(image);
 276 </pre>
 277
 278 <p>The format of the AcquireIndexes() method is:</p>
 279
 280 <pre class="code">
 281   const IndexPacket *AcquireIndexes(const Image *image)
 282 </pre>
 283
 284 <p>A description of each parameter follows:</p></ol>
 285
 286 <h5>indexes</h5>
 287 <ol><p>AcquireIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
 288
 289 <h5>image</h5>
 290 <ol><p>the image.</p></ol>
 291
 292  </div>
 293 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 294 _8c.html" target="source" name="AcquireMemory">AcquireMemory</a></h2>
 295 <div class="doc-section">
 296
 297 <p>AcquireMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.</p></ol>
 298
 299 <p>The format of the AcquireMemory method is:</p>
 300
 301 <pre class="code">
 302   void *AcquireMemory(const size_t size)
 303 </pre>
 304
 305 <p>A description of each parameter follows:</p></ol>
 306
 307 <h5>size</h5>
 308 <ol><p>the size of the memory in bytes to allocate.</p></ol>
 309
 310  </div>
 311 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 312 _8c.html" target="source" name="AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a></h2>
 313 <div class="doc-section">
 314
 315 <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>
 316
 317 <p>Deprecated, replace with:</p>
 318
 319 <pre class="text">
 320       GetOneCacheViewVirtualPixel(cache_view,x,y,pixel,exception);
 321 </pre>
 322
 323 <p>The format of the AcquireOneCacheViewPixel method is:</p>
 324
 325 <pre class="code">
 326   MagickBooleanType AcquireOneCacheViewPixel(const CacheView *cache_view,
 327     const ssize_t x,const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
 328 </pre>
 329
 330 <p>A description of each parameter follows:</p></ol>
 331
 332 <h5>cache_view</h5>
 333 <ol><p>the cache view.</p></ol>
 334
 335 <h5>x,y</h5>
 336 <ol><p>These values define the offset of the pixel.</p></ol>
 337
 338 <h5>pixel</h5>
 339 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 340
 341 <h5>exception</h5>
 342 <ol><p>return any errors or warnings in this structure.</p></ol>
 343
 344  </div>
 345 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 346 _8c.html" target="source" name="AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a></h2>
 347 <div class="doc-section">
 348
 349 <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>
 350
 351 <p>Deprecated, replace with:</p>
 352
 353 <pre class="text">
 354       GetOneCacheViewVirtualMethodPixel(cache_view,virtual_pixel_method,
 355   x,y,pixel,exception);
 356 </pre>
 357
 358 <p>The format of the AcquireOneCacheViewPixel method is:</p>
 359
 360 <pre class="code">
 361   MagickBooleanType AcquireOneCacheViewVirtualPixel(
 362     const CacheView *cache_view,
 363     const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
 364     const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
 365 </pre>
 366
 367 <p>A description of each parameter follows:</p></ol>
 368
 369 <h5>cache_view</h5>
 370 <ol><p>the cache view.</p></ol>
 371
 372 <h5>virtual_pixel_method</h5>
 373 <ol><p>the virtual pixel method.</p></ol>
 374
 375 <h5>x,y</h5>
 376 <ol><p>These values define the offset of the pixel.</p></ol>
 377
 378 <h5>pixel</h5>
 379 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 380
 381 <h5>exception</h5>
 382 <ol><p>return any errors or warnings in this structure.</p></ol>
 383
 384  </div>
 385 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 386 _8c.html" target="source" name="AcquireOneMagickPixel">AcquireOneMagickPixel</a></h2>
 387 <div class="doc-section">
 388
 389 <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>
 390
 391 <p>Deprecated, replace with:</p>
 392
 393 <pre class="text">
 394       MagickPixelPacket pixel;
 395       GetOneVirtualMagickPixel(image,x,y,&pixel,exception);
 396 </pre>
 397
 398 <p>The format of the AcquireOneMagickPixel() method is:</p>
 399
 400 <pre class="code">
 401   MagickPixelPacket AcquireOneMagickPixel(const Image image,const ssize_t x,
 402     const ssize_t y,ExceptionInfo exception)
 403 </pre>
 404
 405 <p>A description of each parameter follows:</p></ol>
 406
 407 <h5>image</h5>
 408 <ol><p>the image.</p></ol>
 409
 410 <h5>x,y</h5>
 411 <ol><p>These values define the location of the pixel to return.</p></ol>
 412
 413 <h5>exception</h5>
 414 <ol><p>return any errors or warnings in this structure.</p></ol>
 415
 416  </div>
 417 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 418 _8c.html" target="source" name="AcquireOnePixel">AcquireOnePixel</a></h2>
 419 <div class="doc-section">
 420
 421 <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>
 422
 423 <p>Deprecated, replace with:</p>
 424
 425 <pre class="text">
 426       PixelPacket pixel;
 427       GetOneVirtualPixel(image,x,y,&pixel,exception);
 428 </pre>
 429
 430 <p>The format of the AcquireOnePixel() method is:</p>
 431
 432 <pre class="code">
 433   PixelPacket AcquireOnePixel(const Image image,const ssize_t x,
 434     const ssize_t y,ExceptionInfo exception)
 435 </pre>
 436
 437 <p>A description of each parameter follows:</p></ol>
 438
 439 <h5>image</h5>
 440 <ol><p>the image.</p></ol>
 441
 442 <h5>x,y</h5>
 443 <ol><p>These values define the location of the pixel to return.</p></ol>
 444
 445 <h5>exception</h5>
 446 <ol><p>return any errors or warnings in this structure.</p></ol>
 447
 448  </div>
 449 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 450 _8c.html" target="source" name="AcquireOneVirtualPixel">AcquireOneVirtualPixel</a></h2>
 451 <div class="doc-section">
 452
 453 <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>
 454
 455 <p>Deprecated, replace with:</p>
 456
 457 <pre class="text">
 458       PixelPacket pixel;
 459       GetOneVirtualMethodPixel(image,virtual_pixel_method,x,y,&pixel,exception);
 460 </pre>
 461
 462 <p>The format of the AcquireOneVirtualPixel() method is:</p>
 463
 464 <pre class="code">
 465   PixelPacket AcquireOneVirtualPixel(const Image image,
 466     const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
 467     const ssize_t y,ExceptionInfo exception)
 468 </pre>
 469
 470 <p>A description of each parameter follows:</p></ol>
 471
 472 <h5>virtual_pixel_method</h5>
 473 <ol><p>the virtual pixel method.</p></ol>
 474
 475 <h5>image</h5>
 476 <ol><p>the image.</p></ol>
 477
 478 <h5>x,y</h5>
 479 <ol><p>These values define the location of the pixel to return.</p></ol>
 480
 481 <h5>exception</h5>
 482 <ol><p>return any errors or warnings in this structure.</p></ol>
 483
 484  </div>
 485 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 486 _8c.html" target="source" name="AcquirePixels">AcquirePixels</a></h2>
 487 <div class="doc-section">
 488
 489 <p>AcquirePixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
 490
 491 <p>Deprecated, replace with:</p>
 492
 493 <pre class="text">
 494       GetVirtualPixelQueue(image);
 495 </pre>
 496
 497 <p>The format of the AcquirePixels() method is:</p>
 498
 499 <pre class="code">
 500   const PixelPacket *AcquirePixels(const Image image)
 501 </pre>
 502
 503 <p>A description of each parameter follows:</p></ol>
 504
 505 <h5>image</h5>
 506 <ol><p>the image.</p></ol>
 507
 508  </div>
 509 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 510 _8c.html" target="source" name="AffinityImage">AffinityImage</a></h2>
 511 <div class="doc-section">
 512
 513 <p>AffinityImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
 514
 515 <p>Deprecated, replace with:</p>
 516
 517 <pre class="text">
 518       RemapImage(quantize_info,image,affinity_image);
 519 </pre>
 520
 521 <p>The format of the AffinityImage method is:</p>
 522
 523 <pre class="code">
 524   MagickBooleanType AffinityImage(const QuantizeInfo *quantize_info,
 525     Image *image,const Image *affinity_image)
 526 </pre>
 527
 528 <p>A description of each parameter follows:</p></ol>
 529
 530 <h5>quantize_info</h5>
 531 <ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
 532
 533 <h5>image</h5>
 534 <ol><p>the image.</p></ol>
 535
 536 <h5>affinity_image</h5>
 537 <ol><p>the reference image.</p></ol>
 538
 539  </div>
 540 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 541 _8c.html" target="source" name="AffinityImages">AffinityImages</a></h2>
 542 <div class="doc-section">
 543
 544 <p>AffinityImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
 545
 546 <p>Deprecated, replace with:</p>
 547
 548 <pre class="text">
 549       RemapImages(quantize_info,images,affinity_image);
 550 </pre>
 551
 552 <p>The format of the AffinityImage method is:</p>
 553
 554 <pre class="code">
 555   MagickBooleanType AffinityImages(const QuantizeInfo *quantize_info,
 556     Image *images,Image *affinity_image)
 557 </pre>
 558
 559 <p>A description of each parameter follows:</p></ol>
 560
 561 <h5>quantize_info</h5>
 562 <ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
 563
 564 <h5>images</h5>
 565 <ol><p>the image sequence.</p></ol>
 566
 567 <h5>affinity_image</h5>
 568 <ol><p>the reference image.</p></ol>
 569
 570  </div>
 571 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 572 _8c.html" target="source" name="AllocateImage">AllocateImage</a></h2>
 573 <div class="doc-section">
 574
 575 <p>AllocateImage() returns a pointer to an image structure initialized to default values.</p></ol>
 576
 577 <p>Deprecated, replace with:</p>
 578
 579 <pre class="text">
 580       AcquireImage(image_info);
 581 </pre>
 582
 583 <p>The format of the AllocateImage method is:</p>
 584
 585 <pre class="code">
 586   Image *AllocateImage(const ImageInfo *image_info)
 587 </pre>
 588
 589 <p>A description of each parameter follows:</p></ol>
 590
 591 <h5>image_info</h5>
 592 <ol><p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p></ol>
 593
 594  </div>
 595 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 596 _8c.html" target="source" name="AllocateImageColormap">AllocateImageColormap</a></h2>
 597 <div class="doc-section">
 598
 599 <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>
 600
 601 <p>Deprecated, replace with:</p>
 602
 603 <pre class="text">
 604       AcquireImageColormap(image,colors);
 605 </pre>
 606
 607 <p>The format of the AllocateImageColormap method is:</p>
 608
 609 <pre class="code">
 610   MagickBooleanType AllocateImageColormap(Image *image,
 611     const size_t colors)
 612 </pre>
 613
 614 <p>A description of each parameter follows:</p></ol>
 615
 616 <h5>image</h5>
 617 <ol><p>the image.</p></ol>
 618
 619 <h5>colors</h5>
 620 <ol><p>the number of colors in the image colormap.</p></ol>
 621
 622  </div>
 623 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 624 _8c.html" target="source" name="AllocateNextImage">AllocateNextImage</a></h2>
 625 <div class="doc-section">
 626
 627 <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>
 628
 629 <p>Deprecated, replace with:</p>
 630
 631 <pre class="text">
 632       AcquireNextImage(image_info,image);
 633 </pre>
 634
 635 <p>The format of the AllocateNextImage method is:</p>
 636
 637 <pre class="code">
 638   void AllocateNextImage(const ImageInfo *image_info,Image *image)
 639 </pre>
 640
 641 <p>A description of each parameter follows:</p></ol>
 642
 643 <h5>image_info</h5>
 644 <ol><p>Many of the image default values are set from this structure.  For example, filename, compression, depth, background color, and others.</p></ol>
 645
 646 <h5>image</h5>
 647 <ol><p>the image.</p></ol>
 648
 649  </div>
 650 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 651 _8c.html" target="source" name="AllocateString">AllocateString</a></h2>
 652 <div class="doc-section">
 653
 654 <p>AllocateString() allocates memory for a string and copies the source string to that memory location (and returns it).</p></ol>
 655
 656 <p>The format of the AllocateString method is:</p>
 657
 658 <pre class="code">
 659   char *AllocateString(const char *source)
 660 </pre>
 661
 662 <p>A description of each parameter follows:</p></ol>
 663
 664 <h5>source</h5>
 665 <ol><p>A character string.</p></ol>
 666
 667  </div>
 668 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 669 _8c.html" target="source" name="AverageImages">AverageImages</a></h2>
 670 <div class="doc-section">
 671
 672 <p>AverageImages() takes a set of images and averages them together.  Each image in the set must have the same width and height.  AverageImages() returns a single image with each corresponding pixel component of each image averaged.   On failure, a NULL image is returned and exception describes the reason for the failure.</p></ol>
 673
 674 <p>Deprecated, replace with:</p>
 675
 676 <pre class="text">
 677       EvaluateImages(images,MeanEvaluateOperator,exception);
 678 </pre>
 679
 680 <p>The format of the AverageImages method is:</p>
 681
 682 <pre class="code">
 683   Image *AverageImages(Image *images,ExceptionInfo *exception)
 684 </pre>
 685
 686 <p>A description of each parameter follows:</p></ol>
 687
 688 <h5>image</h5>
 689 <ol><p>the image sequence.</p></ol>
 690
 691 <h5>exception</h5>
 692 <ol><p>return any errors or warnings in this structure.</p></ol>
 693
 694  </div>
 695 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 696 _8c.html" target="source" name="ChannelThresholdImage">ChannelThresholdImage</a></h2>
 697 <div class="doc-section">
 698
 699 <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>
 700
 701 <p>The format of the ChannelThresholdImage method is:</p>
 702
 703 <pre class="code">
 704   unsigned int ChannelThresholdImage(Image *image,const char *level)
 705 </pre>
 706
 707 <p>A description of each parameter follows:</p></ol>
 708
 709 <h5>image</h5>
 710 <ol><p>the image.</p></ol>
 711
 712 <h5>level</h5>
 713 <ol><p>define the threshold values.</p></ol>
 714
 715  </div>
 716 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 717 _8c.html" target="source" name="ClipPathImage">ClipPathImage</a></h2>
 718 <div class="doc-section">
 719
 720 <p>ClipPathImage() sets the image clip mask based any clipping path information if it exists.</p></ol>
 721
 722 <p>Deprecated, replace with:</p>
 723
 724 <pre class="text">
 725       ClipImagePath(image,pathname,inside);
 726 </pre>
 727
 728 <p>The format of the ClipImage method is:</p>
 729
 730 <pre class="code">
 731   MagickBooleanType ClipPathImage(Image *image,const char *pathname,
 732     const MagickBooleanType inside)
 733 </pre>
 734
 735 <p>A description of each parameter follows:</p></ol>
 736
 737 <h5>image</h5>
 738 <ol><p>the image.</p></ol>
 739
 740 <h5>pathname</h5>
 741 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
 742
 743 <h5>inside</h5>
 744 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
 745
 746  </div>
 747 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 748 _8c.html" target="source" name="CloneImageAttributes">CloneImageAttributes</a></h2>
 749 <div class="doc-section">
 750
 751 <p>CloneImageAttributes() clones one or more image attributes.</p></ol>
 752
 753 <p>Deprecated, replace with:</p>
 754
 755 <pre class="text">
 756       CloneImageProperties(image,clone_image);
 757 </pre>
 758
 759 <p>The format of the CloneImageAttributes method is:</p>
 760
 761 <pre class="code">
 762   MagickBooleanType CloneImageAttributes(Image *image,
 763     const Image *clone_image)
 764 </pre>
 765
 766 <p>A description of each parameter follows:</p></ol>
 767
 768 <h5>image</h5>
 769 <ol><p>the image.</p></ol>
 770
 771 <h5>clone_image</h5>
 772 <ol><p>the clone image.</p></ol>
 773
 774  </div>
 775 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 776 _8c.html" target="source" name="CloneMemory">CloneMemory</a></h2>
 777 <div class="doc-section">
 778
 779 <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>
 780
 781 <p>The format of the CloneMemory method is:</p>
 782
 783 <pre class="code">
 784   void *CloneMemory(void *destination,const void *source,
 785     const size_t size)
 786 </pre>
 787
 788 <p>A description of each parameter follows:</p></ol>
 789
 790 <h5>destination</h5>
 791 <ol><p>the destination.</p></ol>
 792
 793 <h5>source</h5>
 794 <ol><p>the source.</p></ol>
 795
 796 <h5>size</h5>
 797 <ol><p>the size of the memory in bytes to allocate.</p></ol>
 798
 799  </div>
 800 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 801 _8c.html" target="source" name="CloseCacheView">CloseCacheView</a></h2>
 802 <div class="doc-section">
 803
 804 <p>CloseCacheView() closes the specified view returned by a previous call to OpenCacheView().</p></ol>
 805
 806 <p>Deprecated, replace with:</p>
 807
 808 <pre class="text">
 809       DestroyCacheView(view_info);
 810 </pre>
 811
 812 <p>The format of the CloseCacheView method is:</p>
 813
 814 <pre class="code">
 815   CacheView *CloseCacheView(CacheView *view_info)
 816 </pre>
 817
 818 <p>A description of each parameter follows:</p></ol>
 819
 820 <h5>view_info</h5>
 821 <ol><p>the address of a structure of type CacheView.</p></ol>
 822
 823  </div>
 824 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 825 _8c.html" target="source" name="ColorFloodfill">ColorFloodfill</a></h2>
 826 <div class="doc-section">
 827
 828 <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>
 829
 830 <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>
 831
 832 <p>The format of the ColorFloodfillImage method is:</p>
 833
 834 <pre class="code">
 835   MagickBooleanType ColorFloodfillImage(Image *image,
 836     const DrawInfo *draw_info,const PixelPacket target,
 837     const ssize_t x_offset,const ssize_t y_offset,const PaintMethod method)
 838 </pre>
 839
 840 <p>A description of each parameter follows:</p></ol>
 841
 842 <h5>image</h5>
 843 <ol><p>the image.</p></ol>
 844
 845 <h5>draw_info</h5>
 846 <ol><p>the draw info.</p></ol>
 847
 848 <h5>target</h5>
 849 <ol><p>the RGB value of the target color.</p></ol>
 850
 851 <h5>x,y</h5>
 852 <ol><p>the starting location of the operation.</p></ol>
 853
 854 <h5>method</h5>
 855 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
 856
 857  </div>
 858 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 859 _8c.html" target="source" name="DeleteImageAttribute">DeleteImageAttribute</a></h2>
 860 <div class="doc-section">
 861
 862 <p>DeleteImageAttribute() deletes an attribute from the image.</p></ol>
 863
 864 <p>Deprecated, replace with:</p>
 865
 866 <pre class="text">
 867       DeleteImageProperty(image,key);
 868 </pre>
 869
 870 <p>The format of the DeleteImageAttribute method is:</p>
 871
 872 <pre class="code">
 873   MagickBooleanType DeleteImageAttribute(Image *image,const char *key)
 874 </pre>
 875
 876 <p>A description of each parameter follows:</p></ol>
 877
 878 <h5>image</h5>
 879 <ol><p>the image info.</p></ol>
 880
 881 <h5>key</h5>
 882 <ol><p>the image key.</p></ol>
 883
 884  </div>
 885 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 886 _8c.html" target="source" name="DeleteImageList">DeleteImageList</a></h2>
 887 <div class="doc-section">
 888
 889 <p>DeleteImageList() deletes an image at the specified position in the list.</p></ol>
 890
 891 <p>The format of the DeleteImageList method is:</p>
 892
 893 <pre class="code">
 894   unsigned int DeleteImageList(Image *images,const ssize_t offset)
 895 </pre>
 896
 897 <p>A description of each parameter follows:</p></ol>
 898
 899 <h5>images</h5>
 900 <ol><p>the image list.</p></ol>
 901
 902 <h5>offset</h5>
 903 <ol><p>the position within the list.</p></ol>
 904
 905  </div>
 906 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 907 _8c.html" target="source" name="DeleteMagickRegistry">DeleteMagickRegistry</a></h2>
 908 <div class="doc-section">
 909
 910 <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>
 911
 912 <p>Deprecated, replace with:</p>
 913
 914 <pre class="text">
 915       char key[MaxTextExtent];
 916       FormatMagickString(key,MaxTextExtent,"ld\n",id);
 917       DeleteImageRegistry(key);
 918 </pre>
 919
 920 <p>The format of the DeleteMagickRegistry method is:</p>
 921
 922 <pre class="code">
 923   MagickBooleanType DeleteMagickRegistry(const ssize_t id)
 924 </pre>
 925
 926 <p>A description of each parameter follows:</p></ol>
 927
 928 <h5>id</h5>
 929 <ol><p>the registry id.</p></ol>
 930
 931  </div>
 932 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 933 _8c.html" target="source" name="DescribeImage">DescribeImage</a></h2>
 934 <div class="doc-section">
 935
 936 <p>DescribeImage() describes an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p></ol>
 937
 938 <p>Deprecated, replace with:</p>
 939
 940 <pre class="text">
 941       IdentifyImage(image,file,verbose);
 942 </pre>
 943
 944 <p>The format of the DescribeImage method is:</p>
 945
 946 <pre class="code">
 947   MagickBooleanType DescribeImage(Image *image,FILE *file,
 948     const MagickBooleanType verbose)
 949 </pre>
 950
 951 <p>A description of each parameter follows:</p></ol>
 952
 953 <h5>image</h5>
 954 <ol><p>the image.</p></ol>
 955
 956 <h5>file</h5>
 957 <ol><p>the file, typically stdout.</p></ol>
 958
 959 <h5>verbose</h5>
 960 <ol><p>A value other than zero prints more detailed information about the image.</p></ol>
 961
 962  </div>
 963 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 964 _8c.html" target="source" name="DestroyImageAttributes">DestroyImageAttributes</a></h2>
 965 <div class="doc-section">
 966
 967 <p>DestroyImageAttributes() deallocates memory associated with the image attribute list.</p></ol>
 968
 969 <p>The format of the DestroyImageAttributes method is:</p>
 970
 971 <pre class="code">
 972   DestroyImageAttributes(Image *image)
 973 </pre>
 974
 975 <p>A description of each parameter follows:</p></ol>
 976
 977 <h5>image</h5>
 978 <ol><p>the image.</p></ol>
 979
 980  </div>
 981 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
 982 _8c.html" target="source" name="DestroyImages">DestroyImages</a></h2>
 983 <div class="doc-section">
 984
 985 <p>DestroyImages() destroys an image list.</p></ol>
 986
 987 <p>Deprecated, replace with:</p>
 988
 989 <pre class="text">
 990       DestroyImageList(image);
 991 </pre>
 992
 993 <p>The format of the DestroyImages method is:</p>
 994
 995 <pre class="code">
 996   void DestroyImages(Image *image)
 997 </pre>
 998
 999 <p>A description of each parameter follows:</p></ol>
1000
1001 <h5>image</h5>
1002 <ol><p>the image sequence.</p></ol>
1003
1004  </div>
1005 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1006 _8c.html" target="source" name="DestroyMagick">DestroyMagick</a></h2>
1007 <div class="doc-section">
1008
1009 <p>DestroyMagick() destroys the ImageMagick environment.</p></ol>
1010
1011 <p>Deprecated, replace with:</p>
1012
1013 <pre class="text">
1014       MagickCoreTerminus();
1015 </pre>
1016
1017 <p>The format of the DestroyMagick function is:</p>
1018
1019 <pre class="text">
1020   DestroyMagick(void)
1021 </pre>
1022
1023  </div>
1024 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1025 _8c.html" target="source" name="DispatchImage">DispatchImage</a></h2>
1026 <div class="doc-section">
1027
1028 <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, ssize_t, float, or double in the order specified by map.</p></ol>
1029
1030 <p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
1031
1032 <pre class="text">
1033   DispatchImage(image,0,0,640,1,"RGB",CharPixel,pixels,exception);
1034 </pre>
1035
1036 <p>Deprecated, replace with:</p>
1037
1038 <pre class="text">
1039       ExportImagePixels(image,x_offset,y_offset,columns,rows,map,type,pixels,
1040   exception);
1041 </pre>
1042
1043 <p>The format of the DispatchImage method is:</p>
1044
1045 <pre class="code">
1046   unsigned int DispatchImage(const Image *image,const ssize_t x_offset,
1047     const ssize_t y_offset,const size_t columns,
1048     const size_t rows,const char *map,const StorageType type,
1049     void *pixels,ExceptionInfo *exception)
1050 </pre>
1051
1052 <p>A description of each parameter follows:</p></ol>
1053
1054 <h5>image</h5>
1055 <ol><p>the image.</p></ol>
1056
1057 <h5>x_offset, y_offset, columns, rows</h5>
1058 <ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
1059
1060 <h5>map</h5>
1061 <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>
1062
1063 <h5>type</h5>
1064 <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>
1065
1066 <h5>pixels</h5>
1067 <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>
1068
1069 <h5>exception</h5>
1070 <ol><p>return any errors or warnings in this structure.</p></ol>
1071
1072  </div>
1073 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1074 _8c.html" target="source" name="ExtractSubimageFromImageImage">ExtractSubimageFromImageImage</a></h2>
1075 <div class="doc-section">
1076
1077 <p>ExtractSubimageFromImageImage() extracts a region of the image that most closely resembles the reference.</p></ol>
1078
1079 <p>The format of the ExtractSubimageFromImageImage method is:</p>
1080
1081 <pre class="code">
1082   Image *ExtractSubimageFromImage(const Image *image,
1083     const Image *reference,ExceptionInfo *exception)
1084 </pre>
1085
1086 <p>A description of each parameter follows:</p></ol>
1087
1088 <h5>image</h5>
1089 <ol><p>the image.</p></ol>
1090
1091 <h5>reference</h5>
1092 <ol><p>find an area of the image that closely resembles this image.</p></ol>
1093
1094 <h5>exception</h5>
1095 <ol><p>return any errors or warnings in this structure.</p></ol>
1096
1097  </div>
1098 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1099 _8c.html" target="source" name="FlattenImages">FlattenImages</a></h2>
1100 <div class="doc-section">
1101
1102 <p>FlattenImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
1103
1104 <p>Deprecated, replace with:</p>
1105
1106 <pre class="text">
1107       MergeImageLayers(image,FlattenLayer,exception);
1108 </pre>
1109
1110 <p>The format of the FlattenImage method is:</p>
1111
1112 <pre class="code">
1113   Image *FlattenImage(Image *image,ExceptionInfo *exception)
1114 </pre>
1115
1116 <p>A description of each parameter follows:</p></ol>
1117
1118 <h5>image</h5>
1119 <ol><p>the image sequence.</p></ol>
1120
1121 <h5>exception</h5>
1122 <ol><p>return any errors or warnings in this structure.</p></ol>
1123
1124  </div>
1125 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1126 _8c.html" target="source" name="FormatImageAttribute">FormatImageAttribute</a></h2>
1127 <div class="doc-section">
1128
1129 <p>FormatImageAttribute() permits formatted key/value pairs to be saved as an image attribute.</p></ol>
1130
1131 <p>The format of the FormatImageAttribute method is:</p>
1132
1133 <pre class="code">
1134   MagickBooleanType FormatImageAttribute(Image *image,const char *key,
1135     const char *format,...)
1136 </pre>
1137
1138 <p>A description of each parameter follows.</p></ol>
1139
1140 <h5> image</h5>
1141 <ol><p>The image.</p></ol>
1142
1143 <h5> key</h5>
1144 <ol><p>The attribute key.</p></ol>
1145
1146 <h5> format</h5>
1147 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
1148
1149  </div>
1150 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1151 _8c.html" target="source" name="FormatString">FormatString</a></h2>
1152 <div class="doc-section">
1153
1154 <p>FormatString() prints formatted output of a variable argument list.</p></ol>
1155
1156 <p>The format of the FormatString method is:</p>
1157
1158 <pre class="code">
1159   void FormatString(char *string,const char *format,...)
1160 </pre>
1161
1162 <p>A description of each parameter follows.</p></ol>
1163
1164 <h5> string</h5>
1165 <ol><p>Method FormatString returns the formatted string in this character buffer.</p></ol>
1166
1167 <h5> format</h5>
1168 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
1169
1170  </div>
1171 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1172 _8c.html" target="source" name="GetConfigureBlob">GetConfigureBlob</a></h2>
1173 <div class="doc-section">
1174
1175 <p>GetConfigureBlob() returns the specified configure file as a blob.</p></ol>
1176
1177 <p>The format of the GetConfigureBlob method is:</p>
1178
1179 <pre class="code">
1180   void *GetConfigureBlob(const char *filename,ExceptionInfo *exception)
1181 </pre>
1182
1183 <p>A description of each parameter follows:</p></ol>
1184
1185 <h5>filename</h5>
1186 <ol><p>the configure file name.</p></ol>
1187
1188 <h5>path</h5>
1189 <ol><p>return the full path information of the configure file.</p></ol>
1190
1191 <h5>length</h5>
1192 <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>
1193
1194 <h5>exception</h5>
1195 <ol><p>return any errors or warnings in this structure.</p></ol>
1196
1197  </div>
1198 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1199 _8c.html" target="source" name="GetCacheView">GetCacheView</a></h2>
1200 <div class="doc-section">
1201
1202 <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>
1203
1204 <p>Deprecated, replace with:</p>
1205
1206 <pre class="text">
1207       GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
1208   GetCacheViewException(cache_view));
1209 </pre>
1210
1211 <p>The format of the GetCacheView method is:</p>
1212
1213 <pre class="code">
1214   PixelPacket *GetCacheView(CacheView *cache_view,const ssize_t x,
1215     const ssize_t y,const size_t columns,const size_t rows)
1216 </pre>
1217
1218 <p>A description of each parameter follows:</p></ol>
1219
1220 <h5>cache_view</h5>
1221 <ol><p>the address of a structure of type CacheView.</p></ol>
1222
1223 <h5>x,y,columns,rows</h5>
1224 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1225
1226  </div>
1227 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1228 _8c.html" target="source" name="GetCacheViewIndexes">GetCacheViewIndexes</a></h2>
1229 <div class="doc-section">
1230
1231 <p>GetCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
1232
1233 <p>Deprecated, replace with:</p>
1234
1235 <pre class="text">
1236       GetCacheViewAuthenticIndexQueue(cache_view);
1237 </pre>
1238
1239 <p>The format of the GetCacheViewIndexes method is:</p>
1240
1241 <pre class="code">
1242   IndexPacket *GetCacheViewIndexes(CacheView *cache_view)
1243 </pre>
1244
1245 <p>A description of each parameter follows:</p></ol>
1246
1247 <h5>cache_view</h5>
1248 <ol><p>the cache view.</p></ol>
1249
1250  </div>
1251 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1252 _8c.html" target="source" name="GetCacheViewPixels">GetCacheViewPixels</a></h2>
1253 <div class="doc-section">
1254
1255 <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>
1256
1257 <p>Deprecated, replace with:</p>
1258
1259 <pre class="text">
1260       GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
1261   GetCacheViewException(cache_view));
1262 </pre>
1263
1264 <p>The format of the GetCacheViewPixels method is:</p>
1265
1266 <pre class="code">
1267   PixelPacket *GetCacheViewPixels(CacheView *cache_view,const ssize_t x,
1268     const ssize_t y,const size_t columns,const size_t rows)
1269 </pre>
1270
1271 <p>A description of each parameter follows:</p></ol>
1272
1273 <h5>cache_view</h5>
1274 <ol><p>the cache view.</p></ol>
1275
1276 <h5>x,y,columns,rows</h5>
1277 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1278
1279  </div>
1280 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1281 _8c.html" target="source" name="GetImageAttribute">GetImageAttribute</a></h2>
1282 <div class="doc-section">
1283
1284 <p>GetImageAttribute() searches the list of image attributes and returns a pointer to the attribute if it exists otherwise NULL.</p></ol>
1285
1286 <p>The format of the GetImageAttribute method is:</p>
1287
1288 <pre class="code">
1289   const ImageAttribute *GetImageAttribute(const Image *image,
1290     const char *key)
1291 </pre>
1292
1293 <p>A description of each parameter follows:</p></ol>
1294
1295 <h5>image</h5>
1296 <ol><p>the image.</p></ol>
1297
1298 <h5>key</h5>
1299 <ol><p>These character strings are the name of an image attribute to return.</p></ol>
1300
1301  </div>
1302 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1303 _8c.html" target="source" name="GetImageClippingPathAttribute">GetImageClippingPathAttribute</a></h2>
1304 <div class="doc-section">
1305
1306 <p>GetImageClippingPathAttribute() searches the list of image attributes and returns a pointer to a clipping path if it exists otherwise NULL.</p></ol>
1307
1308 <p>Deprecated, replace with:</p>
1309
1310 <pre class="text">
1311       GetImageAttribute(image,"8BIM:1999,2998");
1312 </pre>
1313
1314 <p>The format of the GetImageClippingPathAttribute method is:</p>
1315
1316 <pre class="code">
1317   const ImageAttribute *GetImageClippingPathAttribute(Image *image)
1318 </pre>
1319
1320 <p>A description of each parameter follows:</p></ol>
1321
1322 <h5>attribute</h5>
1323 <ol><p>Method GetImageClippingPathAttribute returns the clipping path if it exists otherwise NULL.</p></ol>
1324
1325 <h5>image</h5>
1326 <ol><p>the image.</p></ol>
1327
1328  </div>
1329 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1330 _8c.html" target="source" name="GetImageFromMagickRegistry">GetImageFromMagickRegistry</a></h2>
1331 <div class="doc-section">
1332
1333 <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>
1334
1335 <p>Deprecated, replace with:</p>
1336
1337 <pre class="text">
1338       GetImageRegistry(ImageRegistryType,name,exception);
1339 </pre>
1340
1341 <p>The format of the GetImageFromMagickRegistry method is:</p>
1342
1343 <pre class="code">
1344   Image *GetImageFromMagickRegistry(const char *name,ssize_t *id,
1345     ExceptionInfo *exception)
1346 </pre>
1347
1348 <p>A description of each parameter follows:</p></ol>
1349
1350 <h5>name</h5>
1351 <ol><p>the name of the image to retrieve from the registry.</p></ol>
1352
1353 <h5>id</h5>
1354 <ol><p>the registry id.</p></ol>
1355
1356 <h5>exception</h5>
1357 <ol><p>return any errors or warnings in this structure.</p></ol>
1358
1359  </div>
1360 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1361 _8c.html" target="source" name="GetMagickRegistry">GetMagickRegistry</a></h2>
1362 <div class="doc-section">
1363
1364 <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>
1365
1366 <p>The format of the GetMagickRegistry method is:</p>
1367
1368 <pre class="code">
1369   const void *GetMagickRegistry(const ssize_t id,RegistryType *type,
1370     size_t *length,ExceptionInfo *exception)
1371 </pre>
1372
1373 <p>A description of each parameter follows:</p></ol>
1374
1375 <h5>id</h5>
1376 <ol><p>the registry id.</p></ol>
1377
1378 <h5>type</h5>
1379 <ol><p>the registry type.</p></ol>
1380
1381 <h5>length</h5>
1382 <ol><p>the blob length in number of bytes.</p></ol>
1383
1384 <h5>exception</h5>
1385 <ol><p>return any errors or warnings in this structure.</p></ol>
1386
1387  </div>
1388 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1389 _8c.html" target="source" name="GetImageGeometry">GetImageGeometry</a></h2>
1390 <div class="doc-section">
1391
1392 <p>GetImageGeometry() returns a region as defined by the geometry string with respect to the image and its gravity.</p></ol>
1393
1394 <p>Deprecated, replace with:</p>
1395
1396 <pre class="text">
1397       if (size_to_fit != MagickFalse)
1398   ParseRegionGeometry(image,geometry,region_info,&image->exception); else
1399   ParsePageGeometry(image,geometry,region_info,&image->exception);
1400 </pre>
1401
1402 <p>The format of the GetImageGeometry method is:</p>
1403
1404 <pre class="code">
1405   int GetImageGeometry(Image *image,const char *geometry,
1406     const unsigned int size_to_fit,RectangeInfo *region_info)
1407 </pre>
1408
1409 <p>A description of each parameter follows:</p></ol>
1410
1411 <h5>flags</h5>
1412 <ol><p>Method GetImageGeometry returns a bitmask that indicates which of the four values were located in the geometry string.</p></ol>
1413
1414 <h5>geometry</h5>
1415 <ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
1416
1417 <h5>size_to_fit</h5>
1418 <ol><p>A value other than 0 means to scale the region so it fits within the specified width and height.</p></ol>
1419
1420 <h5>region_info</h5>
1421 <ol><p>the region as defined by the geometry string with respect to the image and its gravity.</p></ol>
1422
1423  </div>
1424 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1425 _8c.html" target="source" name="GetImageList">GetImageList</a></h2>
1426 <div class="doc-section">
1427
1428 <p>GetImageList() returns an image at the specified position in the list.</p></ol>
1429
1430 <p>Deprecated, replace with:</p>
1431
1432 <pre class="text">
1433       CloneImage(GetImageFromList(images,(ssize_t) offset),0,0,MagickTrue,
1434   exception);
1435 </pre>
1436
1437 <p>The format of the GetImageList method is:</p>
1438
1439 <pre class="code">
1440   Image *GetImageList(const Image *images,const ssize_t offset,
1441     ExceptionInfo *exception)
1442 </pre>
1443
1444 <p>A description of each parameter follows:</p></ol>
1445
1446 <h5>images</h5>
1447 <ol><p>the image list.</p></ol>
1448
1449 <h5>offset</h5>
1450 <ol><p>the position within the list.</p></ol>
1451
1452 <h5>exception</h5>
1453 <ol><p>return any errors or warnings in this structure.</p></ol>
1454
1455  </div>
1456 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1457 _8c.html" target="source" name="GetImageListIndex">GetImageListIndex</a></h2>
1458 <div class="doc-section">
1459
1460 <p>GetImageListIndex() returns the position in the list of the specified image.</p></ol>
1461
1462 <p>Deprecated, replace with:</p>
1463
1464 <pre class="text">
1465       GetImageIndexInList(images);
1466 </pre>
1467
1468 <p>The format of the GetImageListIndex method is:</p>
1469
1470 <pre class="code">
1471   ssize_t GetImageListIndex(const Image *images)
1472 </pre>
1473
1474 <p>A description of each parameter follows:</p></ol>
1475
1476 <h5>images</h5>
1477 <ol><p>the image list.</p></ol>
1478
1479  </div>
1480 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1481 _8c.html" target="source" name="GetImageListSize">GetImageListSize</a></h2>
1482 <div class="doc-section">
1483
1484 <p>GetImageListSize() returns the number of images in the list.</p></ol>
1485
1486 <p>Deprecated, replace with:</p>
1487
1488 <pre class="text">
1489       GetImageListLength(images);
1490 </pre>
1491
1492 <p>The format of the GetImageListSize method is:</p>
1493
1494 <pre class="code">
1495   size_t GetImageListSize(const Image *images)
1496 </pre>
1497
1498 <p>A description of each parameter follows:</p></ol>
1499
1500 <h5>images</h5>
1501 <ol><p>the image list.</p></ol>
1502
1503  </div>
1504 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1505 _8c.html" target="source" name="GetImagePixels">GetImagePixels</a></h2>
1506 <div class="doc-section">
1507
1508 <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>
1509
1510 <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>
1511
1512 <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>
1513
1514 <p>Deprecated, replace with:</p>
1515
1516 <pre class="text">
1517       GetAuthenticPixels(image,x,y,columns,rows,&image->exception);
1518 </pre>
1519
1520 <p>The format of the GetImagePixels() method is:</p>
1521
1522 <pre class="code">
1523   PixelPacket *GetImagePixels(Image *image,const ssize_t x,const ssize_t y,
1524     const size_t columns,const size_t rows)
1525 </pre>
1526
1527 <p>A description of each parameter follows:</p></ol>
1528
1529 <h5>image</h5>
1530 <ol><p>the image.</p></ol>
1531
1532 <h5>x,y,columns,rows</h5>
1533 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1534
1535  </div>
1536 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1537 _8c.html" target="source" name="GetIndexes">GetIndexes</a></h2>
1538 <div class="doc-section">
1539
1540 <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>
1541
1542 <p>Deprecated, replace with:</p>
1543
1544 <pre class="text">
1545       GetAuthenticIndexQueue(image);
1546 </pre>
1547
1548 <p>The format of the GetIndexes() method is:</p>
1549
1550 <pre class="code">
1551   IndexPacket *GetIndexes(const Image *image)
1552 </pre>
1553
1554 <p>A description of each parameter follows:</p></ol>
1555
1556 <h5>indexes</h5>
1557 <ol><p>GetIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1558
1559 <h5>image</h5>
1560 <ol><p>the image.</p></ol>
1561
1562  </div>
1563 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1564 _8c.html" target="source" name="GetNextImage">GetNextImage</a></h2>
1565 <div class="doc-section">
1566
1567 <p>GetNextImage() returns the next image in a list.</p></ol>
1568
1569 <p>Deprecated, replace with:</p>
1570
1571 <pre class="text">
1572       GetNextImageInList(images);
1573 </pre>
1574
1575 <p>The format of the GetNextImage method is:</p>
1576
1577 <pre class="code">
1578   Image *GetNextImage(const Image *images)
1579 </pre>
1580
1581 <p>A description of each parameter follows:</p></ol>
1582
1583 <h5>images</h5>
1584 <ol><p>the image list.</p></ol>
1585
1586  </div>
1587 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1588 _8c.html" target="source" name="GetNextImageAttribute">GetNextImageAttribute</a></h2>
1589 <div class="doc-section">
1590
1591 <p>GetNextImageAttribute() gets the next image attribute.</p></ol>
1592
1593 <p>Deprecated, replace with:</p>
1594
1595 <pre class="text">
1596       const char *property;
1597       property=GetNextImageProperty(image);
1598       if (property != (const char *) NULL)
1599   GetImageAttribute(image,property);
1600 </pre>
1601
1602 <p>The format of the GetNextImageAttribute method is:</p>
1603
1604 <pre class="code">
1605   const ImageAttribute *GetNextImageAttribute(const Image *image)
1606 </pre>
1607
1608 <p>A description of each parameter follows:</p></ol>
1609
1610 <h5>image</h5>
1611 <ol><p>the image.</p></ol>
1612
1613  </div>
1614 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1615 _8c.html" target="source" name="GetNumberScenes">GetNumberScenes</a></h2>
1616 <div class="doc-section">
1617
1618 <p>GetNumberScenes() returns the number of images in the list.</p></ol>
1619
1620 <p>Deprecated, replace with:</p>
1621
1622 <pre class="text">
1623       GetImageListLength(image);
1624 </pre>
1625
1626 <p>The format of the GetNumberScenes method is:</p>
1627
1628 <pre class="code">
1629   unsigned int GetNumberScenes(const Image *images)
1630 </pre>
1631
1632 <p>A description of each parameter follows:</p></ol>
1633
1634 <h5>images</h5>
1635 <ol><p>the image list.</p></ol>
1636
1637  </div>
1638 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1639 _8c.html" target="source" name="GetOnePixel">GetOnePixel</a></h2>
1640 <div class="doc-section">
1641
1642 <p>GetOnePixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
1643
1644 <p>Deprecated, replace with:</p>
1645
1646 <pre class="text">
1647       GetOneAuthenticPixel(image,x,y,&pixel,&image->exception);
1648 </pre>
1649
1650 <p>The format of the GetOnePixel() method is:</p>
1651
1652 <pre class="code">
1653   PixelPacket GetOnePixel(const Image image,const ssize_t x,const ssize_t y)
1654 </pre>
1655
1656 <p>A description of each parameter follows:</p></ol>
1657
1658 <h5>image</h5>
1659 <ol><p>the image.</p></ol>
1660
1661 <h5>x,y</h5>
1662 <ol><p>These values define the location of the pixel to return.</p></ol>
1663
1664  </div>
1665 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1666 _8c.html" target="source" name="GetPixels">GetPixels</a></h2>
1667 <div class="doc-section">
1668
1669 <p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1670
1671 <p>Deprecated, replace with:</p>
1672
1673 <pre class="text">
1674       GetAuthenticPixelQueue(image);
1675 </pre>
1676
1677 <p>The format of the GetPixels() method is:</p>
1678
1679 <pre class="code">
1680   PixelPacket *GetPixels(const Image image)
1681 </pre>
1682
1683 <p>A description of each parameter follows:</p></ol>
1684
1685 <h5>pixels</h5>
1686 <ol><p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1687
1688 <h5>image</h5>
1689 <ol><p>the image.</p></ol>
1690
1691  </div>
1692 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1693 _8c.html" target="source" name="GetPreviousImage">GetPreviousImage</a></h2>
1694 <div class="doc-section">
1695
1696 <p>GetPreviousImage() returns the previous image in a list.</p></ol>
1697
1698 <p>Deprecated, replace with:</p>
1699
1700 <pre class="text">
1701       GetPreviousImageInList(images));
1702 </pre>
1703
1704 <p>The format of the GetPreviousImage method is:</p>
1705
1706 <pre class="code">
1707   Image *GetPreviousImage(const Image *images)
1708 </pre>
1709
1710 <p>A description of each parameter follows:</p></ol>
1711
1712 <h5>images</h5>
1713 <ol><p>the image list.</p></ol>
1714
1715  </div>
1716 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1717 _8c.html" target="source" name="HSLTransform">HSLTransform</a></h2>
1718 <div class="doc-section">
1719
1720 <p>HSLTransform() converts a (hue, saturation, lightness) to a (red, green, blue) triple.</p></ol>
1721
1722 <p>The format of the HSLTransformImage method is:</p>
1723
1724 <pre class="code">
1725   void HSLTransform(const double hue,const double saturation,
1726     const double lightness,Quantum *red,Quantum *green,Quantum *blue)
1727 </pre>
1728
1729 <p>A description of each parameter follows:</p></ol>
1730
1731 <h5>hue, saturation, lightness</h5>
1732 <ol><p>A double value representing a component of the HSL color space.</p></ol>
1733
1734 <h5>red, green, blue</h5>
1735 <ol><p>A pointer to a pixel component of type Quantum.</p></ol>
1736
1737  </div>
1738 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1739 _8c.html" target="source" name="IdentityAffine">IdentityAffine</a></h2>
1740 <div class="doc-section">
1741
1742 <p>IdentityAffine() initializes the affine transform to the identity matrix.</p></ol>
1743
1744 <p>The format of the IdentityAffine method is:</p>
1745
1746 <pre class="code">
1747   IdentityAffine(AffineMatrix *affine)
1748 </pre>
1749
1750 <p>A description of each parameter follows:</p></ol>
1751
1752 <h5>affine</h5>
1753 <ol><p>A pointer the affine transform of type AffineMatrix.</p></ol>
1754
1755  </div>
1756 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1757 _8c.html" target="source" name="InitializeMagick">InitializeMagick</a></h2>
1758 <div class="doc-section">
1759
1760 <p>InitializeMagick() initializes the ImageMagick environment.</p></ol>
1761
1762 <p>Deprecated, replace with:</p>
1763
1764 <pre class="text">
1765       MagickCoreGenesis(path,MagickFalse);
1766 </pre>
1767
1768 <p>The format of the InitializeMagick function is:</p>
1769
1770 <pre class="text">
1771   InitializeMagick(const char *path)
1772 </pre>
1773
1774 <p>A description of each parameter follows:</p></ol>
1775
1776 <h5>path</h5>
1777 <ol><p>the execution path of the current ImageMagick client.</p></ol>
1778
1779  </div>
1780 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1781 _8c.html" target="source" name="InterpolatePixelColor">InterpolatePixelColor</a></h2>
1782 <div class="doc-section">
1783
1784 <p>InterpolatePixelColor() applies bi-linear or tri-linear interpolation between a pixel and it's neighbors.</p></ol>
1785
1786 <p>The format of the InterpolatePixelColor method is:</p>
1787
1788 <pre class="code">
1789   MagickPixelPacket InterpolatePixelColor(const Image *image,
1790     CacheView *view_info,InterpolatePixelMethod method,const double x,
1791     const double y,ExceptionInfo *exception)
1792 </pre>
1793
1794 <p>A description of each parameter follows:</p></ol>
1795
1796 <h5>image</h5>
1797 <ol><p>the image.</p></ol>
1798
1799 <h5>image_view</h5>
1800 <ol><p>the image cache view.</p></ol>
1801
1802 <h5>type</h5>
1803 <ol><p>the type of pixel color interpolation.</p></ol>
1804
1805 <h5>x,y</h5>
1806 <ol><p>A double representing the current (x,y) position of the pixel.</p></ol>
1807
1808 <h5>exception</h5>
1809 <ol><p>return any errors or warnings in this structure.</p></ol>
1810
1811  </div>
1812 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1813 _8c.html" target="source" name="InterpretImageAttributes">InterpretImageAttributes</a></h2>
1814 <div class="doc-section">
1815
1816 <p>InterpretImageAttributes() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
1817
1818 <p>Deprecated, replace with:</p>
1819
1820 <pre class="text">
1821       InterpretImageProperties(image_info,image,embed_text);
1822 </pre>
1823
1824 <p>The format of the InterpretImageAttributes method is:</p>
1825
1826 <pre class="code">
1827   char *InterpretImageAttributes(const ImageInfo *image_info,Image *image,
1828     const char *embed_text)
1829 </pre>
1830
1831 <p>A description of each parameter follows:</p></ol>
1832
1833 <h5>image_info</h5>
1834 <ol><p>the image info.</p></ol>
1835
1836 <h5>image</h5>
1837 <ol><p>the image.</p></ol>
1838
1839 <h5>embed_text</h5>
1840 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
1841
1842  </div>
1843 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1844 _8c.html" target="source" name="LevelImageColor">LevelImageColor</a></h2>
1845 <div class="doc-section">
1846
1847 <p>LevelImageColor() will map the given color to "black" and "white" values, limearly spreading out the colors, and level values on a channel by channel bases, as per LevelImage().  The given colors allows you to specify different level ranges for each of the color channels seperatally.</p></ol>
1848
1849 <p>If the boolean 'invert' is set true the image values will modifyed in the reverse direction. That is any existing "black" and "white" colors in the image will become the color values given, with all other values compressed appropriatally.  This effectivally maps a greyscale gradient into the given color gradient.</p></ol>
1850
1851 <p>Deprecated, replace with:</p>
1852
1853 <pre class="text">
1854       LevelColorsImageChannel(image,channel,black_color,white_color,invert);
1855 </pre>
1856
1857 <p>The format of the LevelImageColors method is:</p>
1858
1859 <pre class="code">
1860     MagickBooleanType LevelImageColors(Image *image,const ChannelType channel,
1861       const MagickPixelPacket *black_color,const MagickPixelPacket *white_color,
1862       const MagickBooleanType invert)
1863 </pre>
1864
1865 <p>A description of each parameter follows:</p></ol>
1866
1867 <h5>image</h5>
1868 <ol><p>the image.</p></ol>
1869
1870 <h5>channel</h5>
1871 <ol><p>the channel.</p></ol>
1872
1873 <h5>black_color</h5>
1874 <ol><p>The color to map black to/from</p></ol>
1875
1876 <h5>white_point</h5>
1877 <ol><p>The color to map white to/from</p></ol>
1878
1879 <h5>invert</h5>
1880 <ol><p>if true map the colors (levelize), rather than from (level)</p></ol>
1881
1882  </div>
1883 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1884 _8c.html" target="source" name="LiberateMemory">LiberateMemory</a></h2>
1885 <div class="doc-section">
1886
1887 <p>LiberateMemory() frees memory that has already been allocated, and NULL's the pointer to it.</p></ol>
1888
1889 <p>The format of the LiberateMemory method is:</p>
1890
1891 <pre class="code">
1892   void LiberateMemory(void **memory)
1893 </pre>
1894
1895 <p>A description of each parameter follows:</p></ol>
1896
1897 <h5>memory</h5>
1898 <ol><p>A pointer to a block of memory to free for reuse.</p></ol>
1899
1900  </div>
1901 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1902 _8c.html" target="source" name="LiberateSemaphoreInfo">LiberateSemaphoreInfo</a></h2>
1903 <div class="doc-section">
1904
1905 <p>LiberateSemaphoreInfo() relinquishes a semaphore.</p></ol>
1906
1907 <p>Deprecated, replace with:</p>
1908
1909 <pre class="text">
1910       UnlockSemaphoreInfo(*semaphore_info);
1911 </pre>
1912
1913 <p>The format of the LiberateSemaphoreInfo method is:</p>
1914
1915 <pre class="code">
1916   LiberateSemaphoreInfo(void **semaphore_info)
1917 </pre>
1918
1919 <p>A description of each parameter follows:</p></ol>
1920
1921 <h5>semaphore_info</h5>
1922 <ol><p>Specifies a pointer to an SemaphoreInfo structure.</p></ol>
1923
1924  </div>
1925 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1926 _8c.html" target="source" name="MagickIncarnate">MagickIncarnate</a></h2>
1927 <div class="doc-section">
1928
1929 <p>MagickIncarnate() initializes the ImageMagick environment.</p></ol>
1930
1931 <p>Deprecated, replace with:</p>
1932
1933 <pre class="text">
1934       MagickCoreGenesis(path,MagickFalse);
1935 </pre>
1936
1937 <p>The format of the MagickIncarnate function is:</p>
1938
1939 <pre class="text">
1940   MagickIncarnate(const char *path)
1941 </pre>
1942
1943 <p>A description of each parameter follows:</p></ol>
1944
1945 <h5>path</h5>
1946 <ol><p>the execution path of the current ImageMagick client.</p></ol>
1947
1948  </div>
1949 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1950 _8c.html" target="source" name="MagickMonitor">MagickMonitor</a></h2>
1951 <div class="doc-section">
1952
1953 <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>
1954
1955 <p>The format of the MagickMonitor method is:</p>
1956
1957 <pre class="code">
1958   MagickBooleanType MagickMonitor(const char *text,
1959     const MagickOffsetType offset,const MagickSizeType span,
1960     void *client_data)
1961 </pre>
1962
1963 <p>A description of each parameter follows:</p></ol>
1964
1965 <h5>offset</h5>
1966 <ol><p>the position relative to the span parameter which represents how much progress has been made toward completing a task.</p></ol>
1967
1968 <h5>span</h5>
1969 <ol><p>the span relative to completing a task.</p></ol>
1970
1971 <h5>client_data</h5>
1972 <ol><p>the client data.</p></ol>
1973
1974  </div>
1975 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1976 _8c.html" target="source" name="MapImage">MapImage</a></h2>
1977 <div class="doc-section">
1978
1979 <p>MapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
1980
1981 <p>Deprecated, replace with:</p>
1982
1983 <pre class="text">
1984        QuantizeInfo quantize_info;
1985        GetQuantizeInfo(&quantize_info);
1986        quantize_info.dither=dither;
1987        RemapImage(&quantize_info,image,map_image);
1988 </pre>
1989
1990 <p>The format of the MapImage method is:</p>
1991
1992 <pre class="code">
1993   MagickBooleanType MapImage(Image *image,const Image *map_image,
1994     const MagickBooleanType dither)
1995 </pre>
1996
1997 <p>A description of each parameter follows:</p></ol>
1998
1999 <h5>image</h5>
2000 <ol><p>Specifies a pointer to an Image structure.</p></ol>
2001
2002 <h5>map_image</h5>
2003 <ol><p>the image.  Reduce image to a set of colors represented by this image.</p></ol>
2004
2005 <h5>dither</h5>
2006 <ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
2007
2008  </div>
2009 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2010 _8c.html" target="source" name="MapImages">MapImages</a></h2>
2011 <div class="doc-section">
2012
2013 <p>MapImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
2014
2015 <p>Deprecated, replace with:</p>
2016
2017 <pre class="text">
2018        QuantizeInfo quantize_info;
2019        GetQuantizeInfo(&quantize_info);
2020        quantize_info.dither=dither;
2021        RemapImages(&quantize_info,images,map_image);
2022 </pre>
2023
2024 <p>The format of the MapImage method is:</p>
2025
2026 <pre class="code">
2027   MagickBooleanType MapImages(Image *images,Image *map_image,
2028     const MagickBooleanType dither)
2029 </pre>
2030
2031 <p>A description of each parameter follows:</p></ol>
2032
2033 <h5>image</h5>
2034 <ol><p>Specifies a pointer to a set of Image structures.</p></ol>
2035
2036 <h5>map_image</h5>
2037 <ol><p>the image.  Reduce image to a set of colors represented by this image.</p></ol>
2038
2039 <h5>dither</h5>
2040 <ol><p>Set this integer value to something other than zero to dither the quantized image.</p></ol>
2041
2042  </div>
2043 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2044 _8c.html" target="source" name="MatteFloodfill">MatteFloodfill</a></h2>
2045 <div class="doc-section">
2046
2047 <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>
2048
2049 <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>
2050
2051 <p>The format of the MatteFloodfillImage method is:</p>
2052
2053 <pre class="code">
2054   MagickBooleanType MatteFloodfillImage(Image *image,
2055     const PixelPacket target,const Quantum opacity,const ssize_t x_offset,
2056     const ssize_t y_offset,const PaintMethod method)
2057 </pre>
2058
2059 <p>A description of each parameter follows:</p></ol>
2060
2061 <h5>image</h5>
2062 <ol><p>the image.</p></ol>
2063
2064 <h5>target</h5>
2065 <ol><p>the RGB value of the target color.</p></ol>
2066
2067 <h5>opacity</h5>
2068 <ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
2069
2070 <h5>x,y</h5>
2071 <ol><p>the starting location of the operation.</p></ol>
2072
2073 <h5>method</h5>
2074 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
2075
2076  </div>
2077 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2078 _8c.html" target="source" name="MaximumImages">MaximumImages</a></h2>
2079 <div class="doc-section">
2080
2081 <p>MaximumImages() returns the maximum intensity of an image sequence.</p></ol>
2082
2083 <p>Deprecated, replace with:</p>
2084
2085 <pre class="text">
2086       EvaluateImages(images,MinEvaluateOperator,exception);
2087 </pre>
2088
2089 <p>The format of the MaxImages method is:</p>
2090
2091 <pre class="code">
2092   Image *MaximumImages(Image *images,ExceptionInfo *exception)
2093 </pre>
2094
2095 <p>A description of each parameter follows:</p></ol>
2096
2097 <h5>images</h5>
2098 <ol><p>the image sequence.</p></ol>
2099
2100 <h5>exception</h5>
2101 <ol><p>return any errors or warnings in this structure.</p></ol>
2102
2103  </div>
2104 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2105 _8c.html" target="source" name="MinimumImages">MinimumImages</a></h2>
2106 <div class="doc-section">
2107
2108 <p>MinimumImages() returns the minimum intensity of an image sequence.</p></ol>
2109
2110 <p>Deprecated, replace with:</p>
2111
2112 <pre class="text">
2113       EvaluateImages(images,MinEvaluateOperator,exception);
2114 </pre>
2115
2116 <p>The format of the MinimumImages method is:</p>
2117
2118 <pre class="code">
2119   Image *MinimumImages(Image *images,ExceptionInfo *exception)
2120 </pre>
2121
2122 <p>A description of each parameter follows:</p></ol>
2123
2124 <h5>images</h5>
2125 <ol><p>the image sequence.</p></ol>
2126
2127 <h5>exception</h5>
2128 <ol><p>return any errors or warnings in this structure.</p></ol>
2129
2130  </div>
2131 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2132 _8c.html" target="source" name="MosaicImages">MosaicImages</a></h2>
2133 <div class="doc-section">
2134
2135 <p>MosaicImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
2136
2137 <p>Deprecated, replace with:</p>
2138
2139 <pre class="text">
2140       MergeImageLayers(image,MosaicLayer,exception);
2141 </pre>
2142
2143 <p>The format of the MosaicImage method is:</p>
2144
2145 <pre class="code">
2146   Image *MosaicImages(const Image *image,ExceptionInfo *exception)
2147 </pre>
2148
2149 <p>A description of each parameter follows:</p></ol>
2150
2151 <h5>image</h5>
2152 <ol><p>the image list to be composited together</p></ol>
2153
2154 <h5>exception</h5>
2155 <ol><p>return any errors or warnings in this structure.</p></ol>
2156
2157  </div>
2158 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2159 _8c.html" target="source" name="OpaqueImage">OpaqueImage</a></h2>
2160 <div class="doc-section">
2161
2162 <p>OpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
2163
2164 <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>
2165
2166 <p>The format of the OpaqueImage method is:</p>
2167
2168 <pre class="code">
2169   MagickBooleanType OpaqueImage(Image *image,
2170     const PixelPacket *target,const PixelPacket fill)
2171 </pre>
2172
2173 <p>A description of each parameter follows:</p></ol>
2174
2175 <h5>image</h5>
2176 <ol><p>the image.</p></ol>
2177
2178 <h5>target</h5>
2179 <ol><p>the RGB value of the target color.</p></ol>
2180
2181 <h5>fill</h5>
2182 <ol><p>the replacement color.</p></ol>
2183
2184  </div>
2185 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2186 _8c.html" target="source" name="OpenCacheView">OpenCacheView</a></h2>
2187 <div class="doc-section">
2188
2189 <p>OpenCacheView() opens a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
2190
2191 <p>Deprecated, replace with:</p>
2192
2193 <pre class="text">
2194       AcquireCacheView(image);
2195 </pre>
2196
2197 <p>The format of the OpenCacheView method is:</p>
2198
2199 <pre class="code">
2200   CacheView *OpenCacheView(const Image *image)
2201 </pre>
2202
2203 <p>A description of each parameter follows:</p></ol>
2204
2205 <h5>image</h5>
2206 <ol><p>the image.</p></ol>
2207
2208  </div>
2209 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2210 _8c.html" target="source" name="PaintFloodfill">PaintFloodfill</a></h2>
2211 <div class="doc-section">
2212
2213 <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>
2214
2215 <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>
2216
2217 <p>Deprecated, replace with:</p>
2218
2219 <pre class="text">
2220       FloodfillPaintImage(image,channel,draw_info,target,x,y,
2221   method == FloodfillMethod ? MagickFalse : MagickTrue);
2222 </pre>
2223
2224 <p>The format of the PaintFloodfillImage method is:</p>
2225
2226 <pre class="code">
2227   MagickBooleanType PaintFloodfillImage(Image *image,
2228     const ChannelType channel,const MagickPixelPacket target,const ssize_t x,
2229     const ssize_t y,const DrawInfo *draw_info,const PaintMethod method)
2230 </pre>
2231
2232 <p>A description of each parameter follows:</p></ol>
2233
2234 <h5>image</h5>
2235 <ol><p>the image.</p></ol>
2236
2237 <h5>channel</h5>
2238 <ol><p>the channel(s).</p></ol>
2239
2240 <h5>target</h5>
2241 <ol><p>the RGB value of the target color.</p></ol>
2242
2243 <h5>x,y</h5>
2244 <ol><p>the starting location of the operation.</p></ol>
2245
2246 <h5>draw_info</h5>
2247 <ol><p>the draw info.</p></ol>
2248
2249 <h5>method</h5>
2250 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
2251
2252  </div>
2253 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2254 _8c.html" target="source" name="PaintOpaqueImage">PaintOpaqueImage</a></h2>
2255 <div class="doc-section">
2256
2257 <p>PaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
2258
2259 <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>
2260
2261 <p>Deprecated, replace with:</p>
2262
2263 <pre class="text">
2264       OpaquePaintImageChannel(image,DefaultChannels,target,fill,MagickFalse);
2265       OpaquePaintImageChannel(image,channel,target,fill,MagickFalse);
2266 </pre>
2267
2268 <p>The format of the PaintOpaqueImage method is:</p>
2269
2270 <pre class="code">
2271   MagickBooleanType PaintOpaqueImage(Image *image,
2272     const PixelPacket *target,const PixelPacket *fill)
2273   MagickBooleanType PaintOpaqueImageChannel(Image *image,
2274     const ChannelType channel,const PixelPacket *target,
2275     const PixelPacket *fill)
2276 </pre>
2277
2278 <p>A description of each parameter follows:</p></ol>
2279
2280 <h5>image</h5>
2281 <ol><p>the image.</p></ol>
2282
2283 <h5>channel</h5>
2284 <ol><p>the channel(s).</p></ol>
2285
2286 <h5>target</h5>
2287 <ol><p>the RGB value of the target color.</p></ol>
2288
2289 <h5>fill</h5>
2290 <ol><p>the replacement color.</p></ol>
2291
2292  </div>
2293 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2294 _8c.html" target="source" name="PaintTransparentImage">PaintTransparentImage</a></h2>
2295 <div class="doc-section">
2296
2297 <p>PaintTransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
2298
2299 <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>
2300
2301 <p>Deprecated, replace with:</p>
2302
2303 <pre class="text">
2304       TransparentPaintImage(image,target,opacity,MagickFalse);
2305 </pre>
2306
2307 <p>The format of the PaintTransparentImage method is:</p>
2308
2309 <pre class="code">
2310   MagickBooleanType PaintTransparentImage(Image *image,
2311     const MagickPixelPacket *target,const Quantum opacity)
2312 </pre>
2313
2314 <p>A description of each parameter follows:</p></ol>
2315
2316 <h5>image</h5>
2317 <ol><p>the image.</p></ol>
2318
2319 <h5>target</h5>
2320 <ol><p>the RGB value of the target color.</p></ol>
2321
2322 <h5>opacity</h5>
2323 <ol><p>the replacement opacity value.</p></ol>
2324
2325  </div>
2326 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2327 _8c.html" target="source" name="ParseSizeGeometry">ParseSizeGeometry</a></h2>
2328 <div class="doc-section">
2329
2330 <p>ParseSizeGeometry() returns a region as defined by the geometry string with respect to the image dimensions and aspect ratio.</p></ol>
2331
2332 <p>Deprecated, replace with:</p>
2333
2334 <pre class="text">
2335       ParseMetaGeometry(geometry,&region_info->x,&region_info->y,
2336   &region_info->width,&region_info->height);
2337 </pre>
2338
2339 <p>The format of the ParseSizeGeometry method is:</p>
2340
2341 <pre class="code">
2342   MagickStatusType ParseSizeGeometry(const Image *image,
2343     const char *geometry,RectangeInfo *region_info)
2344 </pre>
2345
2346 <p>A description of each parameter follows:</p></ol>
2347
2348 <h5>geometry</h5>
2349 <ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
2350
2351 <h5>region_info</h5>
2352 <ol><p>the region as defined by the geometry string.</p></ol>
2353
2354  </div>
2355 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2356 _8c.html" target="source" name="PopImageList">PopImageList</a></h2>
2357 <div class="doc-section">
2358
2359 <p>PopImageList() removes the last image in the list.</p></ol>
2360
2361 <p>Deprecated, replace with:</p>
2362
2363 <pre class="text">
2364       RemoveLastImageFromList(images);
2365 </pre>
2366
2367 <p>The format of the PopImageList method is:</p>
2368
2369 <pre class="code">
2370   Image *PopImageList(Image **images)
2371 </pre>
2372
2373 <p>A description of each parameter follows:</p></ol>
2374
2375 <h5>images</h5>
2376 <ol><p>the image list.</p></ol>
2377
2378  </div>
2379 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2380 _8c.html" target="source" name="PopImagePixels">PopImagePixels</a></h2>
2381 <div class="doc-section">
2382
2383 <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>
2384
2385 <p>The format of the PopImagePixels method is:</p>
2386
2387 <pre class="code">
2388   size_t PopImagePixels(Image *,const QuantumType quantum,
2389     unsigned char *destination)
2390 </pre>
2391
2392 <p>A description of each parameter follows:</p></ol>
2393
2394 <h5>image</h5>
2395 <ol><p>the image.</p></ol>
2396
2397 <h5>quantum</h5>
2398 <ol><p>Declare which pixel components to transfer (RGB, RGBA, etc).</p></ol>
2399
2400 <h5>destination</h5>
2401 <ol><p>The components are transferred to this buffer.</p></ol>
2402
2403  </div>
2404 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2405 _8c.html" target="source" name="PostscriptGeometry">PostscriptGeometry</a></h2>
2406 <div class="doc-section">
2407
2408 <p>PostscriptGeometry() replaces any page mneumonic with the equivalent size in picas.</p></ol>
2409
2410 <p>Deprecated, replace with:</p>
2411
2412 <pre class="text">
2413       GetPageGeometry(page);
2414 </pre>
2415
2416 <p>The format of the PostscriptGeometry method is:</p>
2417
2418 <pre class="code">
2419   char *PostscriptGeometry(const char *page)
2420 </pre>
2421
2422 <p>A description of each parameter follows.</p></ol>
2423
2424 <h5> page</h5>
2425 <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>
2426
2427  </div>
2428 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2429 _8c.html" target="source" name="PushImageList">PushImageList</a></h2>
2430 <div class="doc-section">
2431
2432 <p>PushImageList() adds an image to the end of the list.</p></ol>
2433
2434 <p>Deprecated, replace with:</p>
2435
2436 <pre class="text">
2437       AppendImageToList(images,CloneImageList(image,exception));
2438 </pre>
2439
2440 <p>The format of the PushImageList method is:</p>
2441
2442 <pre class="code">
2443   unsigned int PushImageList(Image *images,const Image *image,
2444     ExceptionInfo *exception)
2445 </pre>
2446
2447 <p>A description of each parameter follows:</p></ol>
2448
2449 <h5>images</h5>
2450 <ol><p>the image list.</p></ol>
2451
2452 <h5>image</h5>
2453 <ol><p>the image.</p></ol>
2454
2455 <h5>exception</h5>
2456 <ol><p>return any errors or warnings in this structure.</p></ol>
2457
2458  </div>
2459 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2460 _8c.html" target="source" name="PushImagePixels">PushImagePixels</a></h2>
2461 <div class="doc-section">
2462
2463 <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>
2464
2465 <p>The format of the PushImagePixels method is:</p>
2466
2467 <pre class="code">
2468   size_t PushImagePixels(Image *image,const QuantumType quantum,
2469     const unsigned char *source)
2470 </pre>
2471
2472 <p>A description of each parameter follows:</p></ol>
2473
2474 <h5>image</h5>
2475 <ol><p>the image.</p></ol>
2476
2477 <h5>quantum</h5>
2478 <ol><p>Declare which pixel components to transfer (red, green, blue, opacity, RGB, or RGBA).</p></ol>
2479
2480 <h5>source</h5>
2481 <ol><p>The pixel components are transferred from this buffer.</p></ol>
2482
2483  </div>
2484 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2485 _8c.html" target="source" name="QuantizationError">QuantizationError</a></h2>
2486 <div class="doc-section">
2487
2488 <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>
2489
2490 <pre class="text">
2491       o mean_error_per_pixel:  This value is the mean error for any single
2492   pixel in the image.
2493 </pre>
2494
2495 <h5>normalized_mean_square_error</h5>
2496 <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>
2497
2498 <h5>normalized_maximum_square_error</h5>
2499 <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>
2500
2501 <p>Deprecated, replace with:</p>
2502
2503 <pre class="text">
2504       GetImageQuantizeError(image);
2505 </pre>
2506
2507 <p>The format of the QuantizationError method is:</p>
2508
2509 <pre class="code">
2510   unsigned int QuantizationError(Image *image)
2511 </pre>
2512
2513 <p>A description of each parameter follows.</p></ol>
2514
2515 <h5>image</h5>
2516 <ol><p>Specifies a pointer to an Image structure;  returned from ReadImage.</p></ol>
2517
2518  </div>
2519 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2520 _8c.html" target="source" name="RandomChannelThresholdImage">RandomChannelThresholdImage</a></h2>
2521 <div class="doc-section">
2522
2523 <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>
2524
2525 <p>The format of the RandomChannelThresholdImage method is:</p>
2526
2527 <pre class="code">
2528   unsigned int RandomChannelThresholdImage(Image *image,
2529      const char *channel, const char *thresholds,
2530      ExceptionInfo *exception)
2531 </pre>
2532
2533 <p>A description of each parameter follows:</p></ol>
2534
2535 <h5>image</h5>
2536 <ol><p>the image.</p></ol>
2537
2538 <h5>channel</h5>
2539 <ol><p>the channel or channels to be thresholded.</p></ol>
2540
2541 <h5>thresholds</h5>
2542 <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>
2543
2544 <h5>exception</h5>
2545 <ol><p>return any errors or warnings in this structure.</p></ol>
2546
2547  </div>
2548 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2549 _8c.html" target="source" name="ReacquireMemory">ReacquireMemory</a></h2>
2550 <div class="doc-section">
2551
2552 <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>
2553
2554 <p>The format of the ReacquireMemory method is:</p>
2555
2556 <pre class="code">
2557   void ReacquireMemory(void **memory,const size_t size)
2558 </pre>
2559
2560 <p>A description of each parameter follows:</p></ol>
2561
2562 <h5>memory</h5>
2563 <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>
2564
2565 <h5>size</h5>
2566 <ol><p>the new size of the allocated memory.</p></ol>
2567
2568  </div>
2569 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2570 _8c.html" target="source" name="RecolorImage">RecolorImage</a></h2>
2571 <div class="doc-section">
2572
2573 <p>RecolorImage() apply color transformation to an image. The method permits saturation changes, hue rotation, luminance to alpha, and various other effects.  Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets).  The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255).</p></ol>
2574
2575 <p>The format of the RecolorImage method is:</p>
2576
2577 <pre class="code">
2578   Image *RecolorImage(const Image *image,const size_t order,
2579     const double *color_matrix,ExceptionInfo *exception)
2580 </pre>
2581
2582 <p>A description of each parameter follows:</p></ol>
2583
2584 <h5>image</h5>
2585 <ol><p>the image.</p></ol>
2586
2587 <h5>order</h5>
2588 <ol><p>the number of columns and rows in the recolor matrix.</p></ol>
2589
2590 <h5>color_matrix</h5>
2591 <ol><p>An array of double representing the recolor matrix.</p></ol>
2592
2593 <h5>exception</h5>
2594 <ol><p>return any errors or warnings in this structure.</p></ol>
2595
2596  </div>
2597 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2598 _8c.html" target="source" name="ResetImageAttributeIterator">ResetImageAttributeIterator</a></h2>
2599 <div class="doc-section">
2600
2601 <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>
2602
2603 <p>Deprecated, replace with:</p>
2604
2605 <pre class="text">
2606       ResetImagePropertyIterator(image);
2607 </pre>
2608
2609 <p>The format of the ResetImageAttributeIterator method is:</p>
2610
2611 <pre class="code">
2612   ResetImageAttributeIterator(const ImageInfo *image)
2613 </pre>
2614
2615 <p>A description of each parameter follows:</p></ol>
2616
2617 <h5>image</h5>
2618 <ol><p>the image.</p></ol>
2619
2620  </div>
2621 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2622 _8c.html" target="source" name="SetCacheViewPixels">SetCacheViewPixels</a></h2>
2623 <div class="doc-section">
2624
2625 <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>
2626
2627 <p>Deprecated, replace with:</p>
2628
2629 <pre class="text">
2630       QueueCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
2631   GetCacheViewException(cache_view));
2632 </pre>
2633
2634 <p>The format of the SetCacheViewPixels method is:</p>
2635
2636 <pre class="code">
2637   PixelPacket *SetCacheViewPixels(CacheView *cache_view,const ssize_t x,
2638     const ssize_t y,const size_t columns,const size_t rows)
2639 </pre>
2640
2641 <p>A description of each parameter follows:</p></ol>
2642
2643 <h5>cache_view</h5>
2644 <ol><p>the cache view.</p></ol>
2645
2646 <h5>x,y,columns,rows</h5>
2647 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
2648
2649  </div>
2650 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2651 _8c.html" target="source" name="SetExceptionInfo">SetExceptionInfo</a></h2>
2652 <div class="doc-section">
2653
2654 <p>SetExceptionInfo() sets the exception severity.</p></ol>
2655
2656 <p>The format of the SetExceptionInfo method is:</p>
2657
2658 <pre class="code">
2659   MagickBooleanType SetExceptionInfo(ExceptionInfo *exception,
2660     ExceptionType severity)
2661 </pre>
2662
2663 <p>A description of each parameter follows:</p></ol>
2664
2665 <h5>exception</h5>
2666 <ol><p>the exception info.</p></ol>
2667
2668 <h5>severity</h5>
2669 <ol><p>the exception severity.</p></ol>
2670
2671  </div>
2672 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2673 _8c.html" target="source" name="SetImage">SetImage</a></h2>
2674 <div class="doc-section">
2675
2676 <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>
2677
2678 <p>The format of the SetImage method is:</p>
2679
2680 <pre class="code">
2681   void SetImage(Image *image,const Quantum opacity)
2682 </pre>
2683
2684 <p>A description of each parameter follows:</p></ol>
2685
2686 <h5>image</h5>
2687 <ol><p>the image.</p></ol>
2688
2689 <h5>opacity</h5>
2690 <ol><p>Set each pixel to this level of transparency.</p></ol>
2691
2692  </div>
2693 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2694 _8c.html" target="source" name="SetImageAttribute">SetImageAttribute</a></h2>
2695 <div class="doc-section">
2696
2697 <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>
2698
2699 <p>Deprecated, replace with:</p>
2700
2701 <pre class="text">
2702       SetImageProperty(image,key,value);
2703 </pre>
2704
2705 <p>The format of the SetImageAttribute method is:</p>
2706
2707 <pre class="code">
2708    MagickBooleanType SetImageAttribute(Image *image,const char *key,
2709      const char *value)
2710 </pre>
2711
2712 <p>A description of each parameter follows:</p></ol>
2713
2714 <h5>image</h5>
2715 <ol><p>the image.</p></ol>
2716
2717 <h5>key</h5>
2718 <ol><p>the key.</p></ol>
2719
2720 <h5>value</h5>
2721 <ol><p>the value.</p></ol>
2722
2723  </div>
2724 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2725 _8c.html" target="source" name="SetImageList">SetImageList</a></h2>
2726 <div class="doc-section">
2727
2728 <p>SetImageList() inserts an image into the list at the specified position.</p></ol>
2729
2730 <p>The format of the SetImageList method is:</p>
2731
2732 <pre class="code">
2733   unsigned int SetImageList(Image *images,const Image *image,
2734     const ssize_t offset,ExceptionInfo *exception)
2735 </pre>
2736
2737 <p>A description of each parameter follows:</p></ol>
2738
2739 <h5>images</h5>
2740 <ol><p>the image list.</p></ol>
2741
2742 <h5>image</h5>
2743 <ol><p>the image.</p></ol>
2744
2745 <h5>offset</h5>
2746 <ol><p>the position within the list.</p></ol>
2747
2748 <h5>exception</h5>
2749 <ol><p>return any errors or warnings in this structure.</p></ol>
2750
2751  </div>
2752 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2753 _8c.html" target="source" name="SetImagePixels">SetImagePixels</a></h2>
2754 <div class="doc-section">
2755
2756 <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>
2757
2758 <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>
2759
2760 <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>
2761
2762 <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>
2763
2764 <p>Deprecated, replace with:</p>
2765
2766 <pre class="text">
2767       QueueAuthenticPixels(image,x,y,columns,rows,&image->exception);
2768 </pre>
2769
2770 <p>The format of the SetImagePixels() method is:</p>
2771
2772 <pre class="code">
2773   PixelPacket *SetImagePixels(Image *image,const ssize_t x,const ssize_t y,
2774     const size_t columns,const size_t rows)
2775 </pre>
2776
2777 <p>A description of each parameter follows:</p></ol>
2778
2779 <h5>pixels</h5>
2780 <ol><p>SetImagePixels returns a pointer to the pixels if they are transferred, otherwise a NULL is returned.</p></ol>
2781
2782 <h5>image</h5>
2783 <ol><p>the image.</p></ol>
2784
2785 <h5>x,y,columns,rows</h5>
2786 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
2787
2788  </div>
2789 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2790 _8c.html" target="source" name="SetMagickRegistry">SetMagickRegistry</a></h2>
2791 <div class="doc-section">
2792
2793 <p>SetMagickRegistry() sets a blob into the registry and returns a unique ID. If an error occurs, -1 is returned.</p></ol>
2794
2795 <p>The format of the SetMagickRegistry method is:</p>
2796
2797 <pre class="code">
2798   ssize_t SetMagickRegistry(const RegistryType type,const void *blob,
2799     const size_t length,ExceptionInfo *exception)
2800 </pre>
2801
2802 <p>A description of each parameter follows:</p></ol>
2803
2804 <h5>type</h5>
2805 <ol><p>the registry type.</p></ol>
2806
2807 <h5>blob</h5>
2808 <ol><p>the address of a Binary Large OBject.</p></ol>
2809
2810 <h5>length</h5>
2811 <ol><p>For a registry type of ImageRegistryType use sizeof(Image) otherise the blob length in number of bytes.</p></ol>
2812
2813 <h5>exception</h5>
2814 <ol><p>return any errors or warnings in this structure.</p></ol>
2815
2816  </div>
2817 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2818 _8c.html" target="source" name="SetMonitorHandler">SetMonitorHandler</a></h2>
2819 <div class="doc-section">
2820
2821 <p>SetMonitorHandler() sets the monitor handler to the specified method and returns the previous monitor handler.</p></ol>
2822
2823 <p>The format of the SetMonitorHandler method is:</p>
2824
2825 <pre class="code">
2826   MonitorHandler SetMonitorHandler(MonitorHandler handler)
2827 </pre>
2828
2829 <p>A description of each parameter follows:</p></ol>
2830
2831 <h5>handler</h5>
2832 <ol><p>Specifies a pointer to a method to handle monitors.</p></ol>
2833
2834  </div>
2835 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2836 _8c.html" target="source" name="ShiftImageList">ShiftImageList</a></h2>
2837 <div class="doc-section">
2838
2839 <p>ShiftImageList() removes an image from the beginning of the list.</p></ol>
2840
2841 <p>Deprecated, replace with:</p>
2842
2843 <pre class="text">
2844       RemoveFirstImageFromList(images);
2845 </pre>
2846
2847 <p>The format of the ShiftImageList method is:</p>
2848
2849 <pre class="code">
2850   Image *ShiftImageList(Image **images)
2851 </pre>
2852
2853 <p>A description of each parameter follows:</p></ol>
2854
2855 <h5>images</h5>
2856 <ol><p>the image list.</p></ol>
2857
2858  </div>
2859 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2860 _8c.html" target="source" name="SpliceImageList">SpliceImageList</a></h2>
2861 <div class="doc-section">
2862
2863 <p>SpliceImageList() removes the images designated by offset and length from the list and replaces them with the specified list.</p></ol>
2864
2865 <p>The format of the SpliceImageList method is:</p>
2866
2867 <pre class="code">
2868   Image *SpliceImageList(Image *images,const ssize_t offset,
2869     const size_t length,const Image *splices,
2870     ExceptionInfo *exception)
2871 </pre>
2872
2873 <p>A description of each parameter follows:</p></ol>
2874
2875 <h5>images</h5>
2876 <ol><p>the image list.</p></ol>
2877
2878 <h5>offset</h5>
2879 <ol><p>the position within the list.</p></ol>
2880
2881 <h5>length</h5>
2882 <ol><p>the length of the image list to remove.</p></ol>
2883
2884 <h5>splice</h5>
2885 <ol><p>Replace the removed image list with this list.</p></ol>
2886
2887 <h5>exception</h5>
2888 <ol><p>return any errors or warnings in this structure.</p></ol>
2889
2890  </div>
2891 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2892 _8c.html" target="source" name="Strip">Strip</a></h2>
2893 <div class="doc-section">
2894
2895 <p>Strip() strips any whitespace or quotes from the beginning and end of a string of characters.</p></ol>
2896
2897 <p>The format of the Strip method is:</p>
2898
2899 <pre class="code">
2900   void Strip(char *message)
2901 </pre>
2902
2903 <p>A description of each parameter follows:</p></ol>
2904
2905 <h5>message</h5>
2906 <ol><p>Specifies an array of characters.</p></ol>
2907
2908  </div>
2909 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2910 _8c.html" target="source" name="SyncCacheView">SyncCacheView</a></h2>
2911 <div class="doc-section">
2912
2913 <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>
2914
2915 <p>Deprecated, replace with:</p>
2916
2917 <pre class="text">
2918       SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
2919 </pre>
2920
2921 <p>The format of the SyncCacheView method is:</p>
2922
2923 <pre class="code">
2924   MagickBooleanType SyncCacheView(CacheView *cache_view)
2925 </pre>
2926
2927 <p>A description of each parameter follows:</p></ol>
2928
2929 <h5>cache_view</h5>
2930 <ol><p>the cache view.</p></ol>
2931
2932  </div>
2933 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2934 _8c.html" target="source" name="SyncCacheViewPixels">SyncCacheViewPixels</a></h2>
2935 <div class="doc-section">
2936
2937 <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>
2938
2939 <p>Deprecated, replace with:</p>
2940
2941 <pre class="text">
2942       SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
2943 </pre>
2944
2945 <p>The format of the SyncCacheViewPixels method is:</p>
2946
2947 <pre class="code">
2948   MagickBooleanType SyncCacheViewPixels(CacheView *cache_view)
2949 </pre>
2950
2951 <p>A description of each parameter follows:</p></ol>
2952
2953 <h5>cache_view</h5>
2954 <ol><p>the cache view.</p></ol>
2955
2956 <h5>exception</h5>
2957 <ol><p>return any errors or warnings in this structure.</p></ol>
2958
2959  </div>
2960 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2961 _8c.html" target="source" name="SyncImagePixels">SyncImagePixels</a></h2>
2962 <div class="doc-section">
2963
2964 <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>
2965
2966 <p>Deprecated, replace with:</p>
2967
2968 <pre class="text">
2969       SyncAuthenticPixels(image,&image->exception);
2970 </pre>
2971
2972 <p>The format of the SyncImagePixels() method is:</p>
2973
2974 <pre class="code">
2975   MagickBooleanType SyncImagePixels(Image *image)
2976 </pre>
2977
2978 <p>A description of each parameter follows:</p></ol>
2979
2980 <h5>image</h5>
2981 <ol><p>the image.</p></ol>
2982
2983  </div>
2984 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2985 _8c.html" target="source" name="TemporaryFilename">TemporaryFilename</a></h2>
2986 <div class="doc-section">
2987
2988 <p>TemporaryFilename() replaces the contents of path by a unique path name.</p></ol>
2989
2990 <p>The format of the TemporaryFilename method is:</p>
2991
2992 <pre class="code">
2993   void TemporaryFilename(char *path)
2994 </pre>
2995
2996 <p>A description of each parameter follows.</p></ol>
2997
2998 <h5> path</h5>
2999 <ol><p>Specifies a pointer to an array of characters.  The unique path name is returned in this array.</p></ol>
3000
3001  </div>
3002 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3003 _8c.html" target="source" name="ThresholdImage">ThresholdImage</a></h2>
3004 <div class="doc-section">
3005
3006 <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>
3007
3008 <p>The format of the ThresholdImage method is:</p>
3009
3010 <pre class="code">
3011   unsigned int ThresholdImage(Image *image,const double threshold)
3012 </pre>
3013
3014 <p>A description of each parameter follows:</p></ol>
3015
3016 <h5>image</h5>
3017 <ol><p>the image.</p></ol>
3018
3019 <h5>threshold</h5>
3020 <ol><p>Define the threshold value</p></ol>
3021
3022  </div>
3023 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3024 _8c.html" target="source" name="ThresholdImageChannel">ThresholdImageChannel</a></h2>
3025 <div class="doc-section">
3026
3027 <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>
3028
3029 <p>The format of the ThresholdImageChannel method is:</p>
3030
3031 <pre class="code">
3032   unsigned int ThresholdImageChannel(Image *image,const char *threshold)
3033 </pre>
3034
3035 <p>A description of each parameter follows:</p></ol>
3036
3037 <h5>image</h5>
3038 <ol><p>the image.</p></ol>
3039
3040 <h5>threshold</h5>
3041 <ol><p>define the threshold values.</p></ol>
3042
3043  </div>
3044 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3045 _8c.html" target="source" name="TransformHSL">TransformHSL</a></h2>
3046 <div class="doc-section">
3047
3048 <p>TransformHSL() converts a (red, green, blue) to a (hue, saturation, lightness) triple.</p></ol>
3049
3050 <p>The format of the TransformHSL method is:</p>
3051
3052 <pre class="code">
3053   void TransformHSL(const Quantum red,const Quantum green,
3054     const Quantum blue,double *hue,double *saturation,double *lightness)
3055 </pre>
3056
3057 <p>A description of each parameter follows:</p></ol>
3058
3059 <h5>red, green, blue</h5>
3060 <ol><p>A Quantum value representing the red, green, and blue component of a pixel..</p></ol>
3061
3062 <h5>hue, saturation, lightness</h5>
3063 <ol><p>A pointer to a double value representing a component of the HSL color space.</p></ol>
3064
3065  </div>
3066 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3067 _8c.html" target="source" name="TranslateText">TranslateText</a></h2>
3068 <div class="doc-section">
3069
3070 <p>TranslateText() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
3071
3072 <p>Deprecated, replace with:</p>
3073
3074 <pre class="text">
3075       InterpretImageProperties(image_info,image,embed_text);
3076 </pre>
3077
3078 <p>The format of the TranslateText method is:</p>
3079
3080 <pre class="code">
3081   char *TranslateText(const ImageInfo *image_info,Image *image,
3082     const char *embed_text)
3083 </pre>
3084
3085 <p>A description of each parameter follows:</p></ol>
3086
3087 <h5>image_info</h5>
3088 <ol><p>the image info.</p></ol>
3089
3090 <h5>image</h5>
3091 <ol><p>the image.</p></ol>
3092
3093 <h5>embed_text</h5>
3094 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
3095
3096  </div>
3097 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3098 _8c.html" target="source" name="TransparentImage">TransparentImage</a></h2>
3099 <div class="doc-section">
3100
3101 <p>TransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
3102
3103 <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>
3104
3105 <p>The format of the TransparentImage method is:</p>
3106
3107 <pre class="code">
3108   MagickBooleanType TransparentImage(Image *image,
3109     const PixelPacket target,const Quantum opacity)
3110 </pre>
3111
3112 <p>A description of each parameter follows:</p></ol>
3113
3114 <h5>image</h5>
3115 <ol><p>the image.</p></ol>
3116
3117 <h5>target</h5>
3118 <ol><p>the RGB value of the target color.</p></ol>
3119
3120 <h5>opacity</h5>
3121 <ol><p>the replacement opacity value.</p></ol>
3122
3123  </div>
3124 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3125 _8c.html" target="source" name="UnshiftImageList">UnshiftImageList</a></h2>
3126 <div class="doc-section">
3127
3128 <p>UnshiftImageList() adds the image to the beginning of the list.</p></ol>
3129
3130 <p>Deprecated, replace with:</p>
3131
3132 <pre class="text">
3133       PrependImageToList(images,CloneImageList(image,exception));
3134 </pre>
3135
3136 <p>The format of the UnshiftImageList method is:</p>
3137
3138 <pre class="code">
3139   unsigned int UnshiftImageList(Image *images,const Image *image,
3140     ExceptionInfo *exception)
3141 </pre>
3142
3143 <p>A description of each parameter follows:</p></ol>
3144
3145 <h5>images</h5>
3146 <ol><p>the image list.</p></ol>
3147
3148 <h5>image</h5>
3149 <ol><p>the image.</p></ol>
3150
3151 <h5>exception</h5>
3152 <ol><p>return any errors or warnings in this structure.</p></ol>
3153
3154  </div>
3155 \r
3156 </div>\r
3157 \r
3158 <div id="linkbar">\r
3159     <span id="linkbar-west">&nbsp;</span>\r
3160     <span id="linkbar-center">\r
3161       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
3162       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
3163     </span>\r
3164     <span id="linkbar-east">&nbsp;</span>\r
3165   </div>\r
3166   <div class="footer">\r
3167     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
3168     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
3169   </div>\r
3170   <div style="clear: both; margin: 0; width: 100%; "></div>\r
3171   <script type="text/javascript">\r
3172     var _gaq = _gaq || [];\r
3173     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
3174     _gaq.push(['_trackPageview']);\r
3175 \r
3176     (function() {\r
3177       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
3178       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
3179       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
3180     })();\r
3181   </script>\r
3182 </body>\r
3183 </html>\r