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

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