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