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