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