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

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