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