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
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="all">
\r
9 @import url("../../www/magick.css");
\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"/>
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
45 <div class="eastbar">
\r
48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
50 <div class="sep"></div>
\r
52 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
63 <div class="sep"></div>
\r
65 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
68 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
71 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
77 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
80 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
83 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
86 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
89 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
91 <div class="sep"></div>
\r
93 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
96 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
99 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
102 <a title="Resources" href="../../www/resources.html">Resources</a>
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
108 <a title="Download" href="../../www/download.html">Download</a>
110 <div class="sep"></div>
\r
112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
114 <div class="sep"></div>
\r
116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
121 <div class="sep"></div>
\r
123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
125 <div class="sponsbox">
126 <div class="sponsor">
127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
129 <div class="sponsor">
130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
132 <div class="sponsor">
133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
135 <div class="sponsor">
136 <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
138 <div class="sponsor">
139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
141 <div class="sponsor">
142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
144 <div class="sponsor">
145 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20110101000120 -->
155 <p class="navigation-index">[<a href="#AcquireCacheViewIndexes">AcquireCacheViewIndexes</a> • <a href="#AcquireCacheViewPixels">AcquireCacheViewPixels</a> • <a href="#AcquireImagePixels">AcquireImagePixels</a> • <a href="#AcquireIndexes">AcquireIndexes</a> • <a href="#AcquireMemory">AcquireMemory</a> • <a href="#AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a> • <a href="#AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a> • <a href="#AcquireOneMagickPixel">AcquireOneMagickPixel</a> • <a href="#AcquireOnePixel">AcquireOnePixel</a> • <a href="#AcquireOneVirtualPixel">AcquireOneVirtualPixel</a> • <a href="#AcquirePixels">AcquirePixels</a> • <a href="#AffinityImage">AffinityImage</a> • <a href="#AffinityImages">AffinityImages</a> • <a href="#AllocateImage">AllocateImage</a> • <a href="#AllocateImageColormap">AllocateImageColormap</a> • <a href="#AllocateNextImage">AllocateNextImage</a> • <a href="#AllocateString">AllocateString</a> • <a href="#AverageImages">AverageImages</a> • <a href="#ChannelThresholdImage">ChannelThresholdImage</a> • <a href="#ClipPathImage">ClipPathImage</a> • <a href="#CloneImageAttributes">CloneImageAttributes</a> • <a href="#CloneMemory">CloneMemory</a> • <a href="#CloseCacheView">CloseCacheView</a> • <a href="#ColorFloodfill">ColorFloodfill</a> • <a href="#DeleteImageAttribute">DeleteImageAttribute</a> • <a href="#DeleteImageList">DeleteImageList</a> • <a href="#DeleteMagickRegistry">DeleteMagickRegistry</a> • <a href="#DescribeImage">DescribeImage</a> • <a href="#DestroyImageAttributes">DestroyImageAttributes</a> • <a href="#DestroyImages">DestroyImages</a> • <a href="#DestroyMagick">DestroyMagick</a> • <a href="#DispatchImage">DispatchImage</a> • <a href="#ExtractSubimageFromImageImage">ExtractSubimageFromImageImage</a> • <a href="#FlattenImages">FlattenImages</a> • <a href="#FormatImageAttribute">FormatImageAttribute</a> • <a href="#FormatString">FormatString</a> • <a href="#GetConfigureBlob">GetConfigureBlob</a> • <a href="#GetCacheView">GetCacheView</a> • <a href="#GetCacheViewIndexes">GetCacheViewIndexes</a> • <a href="#GetCacheViewPixels">GetCacheViewPixels</a> • <a href="#GetImageAttribute">GetImageAttribute</a> • <a href="#GetImageClippingPathAttribute">GetImageClippingPathAttribute</a> • <a href="#GetImageFromMagickRegistry">GetImageFromMagickRegistry</a> • <a href="#GetMagickRegistry">GetMagickRegistry</a> • <a href="#GetImageGeometry">GetImageGeometry</a> • <a href="#GetImageList">GetImageList</a> • <a href="#GetImageListIndex">GetImageListIndex</a> • <a href="#GetImageListSize">GetImageListSize</a> • <a href="#GetImagePixels">GetImagePixels</a> • <a href="#GetIndexes">GetIndexes</a> • <a href="#GetNextImage">GetNextImage</a> • <a href="#GetNextImageAttribute">GetNextImageAttribute</a> • <a href="#GetNumberScenes">GetNumberScenes</a> • <a href="#GetOnePixel">GetOnePixel</a> • <a href="#GetPixels">GetPixels</a> • <a href="#GetPreviousImage">GetPreviousImage</a> • <a href="#HSLTransform">HSLTransform</a> • <a href="#IdentityAffine">IdentityAffine</a> • <a href="#InitializeMagick">InitializeMagick</a> • <a href="#InterpolatePixelColor">InterpolatePixelColor</a> • <a href="#InterpretImageAttributes">InterpretImageAttributes</a> • <a href="#LevelImageColor">LevelImageColor</a> • <a href="#LiberateMemory">LiberateMemory</a> • <a href="#LiberateSemaphoreInfo">LiberateSemaphoreInfo</a> • <a href="#MagickIncarnate">MagickIncarnate</a> • <a href="#MagickMonitor">MagickMonitor</a> • <a href="#MapImage">MapImage</a> • <a href="#MapImages">MapImages</a> • <a href="#MatteFloodfill">MatteFloodfill</a> • <a href="#MaximumImages">MaximumImages</a> • <a href="#MinimumImages">MinimumImages</a> • <a href="#MosaicImages">MosaicImages</a> • <a href="#OpaqueImage">OpaqueImage</a> • <a href="#OpenCacheView">OpenCacheView</a> • <a href="#PaintFloodfill">PaintFloodfill</a> • <a href="#PaintOpaqueImage">PaintOpaqueImage</a> • <a href="#PaintTransparentImage">PaintTransparentImage</a> • <a href="#ParseSizeGeometry">ParseSizeGeometry</a> • <a href="#PopImageList">PopImageList</a> • <a href="#PopImagePixels">PopImagePixels</a> • <a href="#PostscriptGeometry">PostscriptGeometry</a> • <a href="#PushImageList">PushImageList</a> • <a href="#PushImagePixels">PushImagePixels</a> • <a href="#QuantizationError">QuantizationError</a> • <a href="#RandomChannelThresholdImage">RandomChannelThresholdImage</a> • <a href="#ReacquireMemory">ReacquireMemory</a> • <a href="#RecolorImage">RecolorImage</a> • <a href="#ResetImageAttributeIterator">ResetImageAttributeIterator</a> • <a href="#SetCacheViewPixels">SetCacheViewPixels</a> • <a href="#SetExceptionInfo">SetExceptionInfo</a> • <a href="#SetImage">SetImage</a> • <a href="#SetImageAttribute">SetImageAttribute</a> • <a href="#SetImageList">SetImageList</a> • <a href="#SetImagePixels">SetImagePixels</a> • <a href="#SetMagickRegistry">SetMagickRegistry</a> • <a href="#SetMonitorHandler">SetMonitorHandler</a> • <a href="#ShiftImageList">ShiftImageList</a> • <a href="#SpliceImageList">SpliceImageList</a> • <a href="#Strip">Strip</a> • <a href="#SyncCacheView">SyncCacheView</a> • <a href="#SyncCacheViewPixels">SyncCacheViewPixels</a> • <a href="#SyncImagePixels">SyncImagePixels</a> • <a href="#TemporaryFilename">TemporaryFilename</a> • <a href="#ThresholdImage">ThresholdImage</a> • <a href="#ThresholdImageChannel">ThresholdImageChannel</a> • <a href="#TransformHSL">TransformHSL</a> • <a href="#TranslateText">TranslateText</a> • <a href="#TransparentImage">TransparentImage</a> • <a href="#UnshiftImageList">UnshiftImageList</a>]</p>
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">
161 <p>AcquireCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
163 <p>Deprecated, replace with:</p>
166 GetCacheViewVirtualIndexQueue(cache_view);
169 <p>The format of the AcquireCacheViewIndexes method is:</p>
172 const IndexPacket *AcquireCacheViewIndexes(const CacheView *cache_view)
175 <p>A description of each parameter follows:</p></ol>
178 <ol><p>the cache view.</p></ol>
181 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
182 _8c.html" target="source" name="AcquireCacheViewPixels">AcquireCacheViewPixels</a></h2>
183 <div class="doc-section">
185 <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>
187 <p>Deprecated, replace with:</p>
190 GetCacheViewVirtualPixels(cache_view,x,y,columns,rows,exception);
193 <p>The format of the AcquireCacheViewPixels method is:</p>
196 const PixelPacket *AcquireCacheViewPixels(const CacheView *cache_view,
197 const ssize_t x,const ssize_t y,const size_t columns,
198 const size_t rows,ExceptionInfo *exception)
201 <p>A description of each parameter follows:</p></ol>
204 <ol><p>the cache view.</p></ol>
206 <h5>x,y,columns,rows</h5>
207 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
210 <ol><p>return any errors or warnings in this structure.</p></ol>
213 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
214 _8c.html" target="source" name="AcquireImagePixels">AcquireImagePixels</a></h2>
215 <div class="doc-section">
217 <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>
219 <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>
221 <p>If you plan to modify the pixels, use GetAuthenticPixels() instead.</p></ol>
223 <p>Note, the AcquireImagePixels() and GetAuthenticPixels() methods are not thread-safe. In a threaded environment, use GetCacheViewVirtualPixels() or GetCacheViewAuthenticPixels() instead.</p></ol>
225 <p>Deprecated, replace with:</p>
228 GetVirtualPixels(image,x,y,columns,rows,exception);
231 <p>The format of the AcquireImagePixels() method is:</p>
234 const PixelPacket *AcquireImagePixels(const Image *image,const ssize_t x,
235 const ssize_t y,const size_t columns,const size_t rows,
236 ExceptionInfo *exception)
239 <p>A description of each parameter follows:</p></ol>
242 <ol><p>the image.</p></ol>
244 <h5>x,y,columns,rows</h5>
245 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
248 <ol><p>return any errors or warnings in this structure.</p></ol>
251 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
252 _8c.html" target="source" name="AcquireIndexes">AcquireIndexes</a></h2>
253 <div class="doc-section">
255 <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>
257 <p>Deprecated, replace with:</p>
260 GetVirtualIndexQueue(image);
263 <p>The format of the AcquireIndexes() method is:</p>
266 const IndexPacket *AcquireIndexes(const Image *image)
269 <p>A description of each parameter follows:</p></ol>
272 <ol><p>AcquireIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
275 <ol><p>the image.</p></ol>
278 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
279 _8c.html" target="source" name="AcquireMemory">AcquireMemory</a></h2>
280 <div class="doc-section">
282 <p>AcquireMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.</p></ol>
284 <p>The format of the AcquireMemory method is:</p>
287 void *AcquireMemory(const size_t size)
290 <p>A description of each parameter follows:</p></ol>
293 <ol><p>the size of the memory in bytes to allocate.</p></ol>
296 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
297 _8c.html" target="source" name="AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a></h2>
298 <div class="doc-section">
300 <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>
302 <p>Deprecated, replace with:</p>
305 GetOneCacheViewVirtualPixel(cache_view,x,y,pixel,exception);
308 <p>The format of the AcquireOneCacheViewPixel method is:</p>
311 MagickBooleanType AcquireOneCacheViewPixel(const CacheView *cache_view,
312 const ssize_t x,const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
315 <p>A description of each parameter follows:</p></ol>
318 <ol><p>the cache view.</p></ol>
321 <ol><p>These values define the offset of the pixel.</p></ol>
324 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
327 <ol><p>return any errors or warnings in this structure.</p></ol>
330 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
331 _8c.html" target="source" name="AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a></h2>
332 <div class="doc-section">
334 <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>
336 <p>Deprecated, replace with:</p>
339 GetOneCacheViewVirtualMethodPixel(cache_view,virtual_pixel_method,
340 x,y,pixel,exception);
343 <p>The format of the AcquireOneCacheViewPixel method is:</p>
346 MagickBooleanType AcquireOneCacheViewVirtualPixel(
347 const CacheView *cache_view,
348 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
349 const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
352 <p>A description of each parameter follows:</p></ol>
355 <ol><p>the cache view.</p></ol>
357 <h5>virtual_pixel_method</h5>
358 <ol><p>the virtual pixel method.</p></ol>
361 <ol><p>These values define the offset of the pixel.</p></ol>
364 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
367 <ol><p>return any errors or warnings in this structure.</p></ol>
370 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
371 _8c.html" target="source" name="AcquireOneMagickPixel">AcquireOneMagickPixel</a></h2>
372 <div class="doc-section">
374 <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>
376 <p>Deprecated, replace with:</p>
379 MagickPixelPacket pixel;
380 GetOneVirtualMagickPixel(image,x,y,&pixel,exception);
383 <p>The format of the AcquireOneMagickPixel() method is:</p>
386 MagickPixelPacket AcquireOneMagickPixel(const Image image,const ssize_t x,
387 const ssize_t y,ExceptionInfo exception)
390 <p>A description of each parameter follows:</p></ol>
393 <ol><p>the image.</p></ol>
396 <ol><p>These values define the location of the pixel to return.</p></ol>
399 <ol><p>return any errors or warnings in this structure.</p></ol>
402 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
403 _8c.html" target="source" name="AcquireOnePixel">AcquireOnePixel</a></h2>
404 <div class="doc-section">
406 <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>
408 <p>Deprecated, replace with:</p>
412 GetOneVirtualPixel(image,x,y,&pixel,exception);
415 <p>The format of the AcquireOnePixel() method is:</p>
418 PixelPacket AcquireOnePixel(const Image image,const ssize_t x,
419 const ssize_t y,ExceptionInfo exception)
422 <p>A description of each parameter follows:</p></ol>
425 <ol><p>the image.</p></ol>
428 <ol><p>These values define the location of the pixel to return.</p></ol>
431 <ol><p>return any errors or warnings in this structure.</p></ol>
434 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
435 _8c.html" target="source" name="AcquireOneVirtualPixel">AcquireOneVirtualPixel</a></h2>
436 <div class="doc-section">
438 <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>
440 <p>Deprecated, replace with:</p>
444 GetOneVirtualMethodPixel(image,virtual_pixel_method,x,y,&pixel,exception);
447 <p>The format of the AcquireOneVirtualPixel() method is:</p>
450 PixelPacket AcquireOneVirtualPixel(const Image image,
451 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
452 const ssize_t y,ExceptionInfo exception)
455 <p>A description of each parameter follows:</p></ol>
457 <h5>virtual_pixel_method</h5>
458 <ol><p>the virtual pixel method.</p></ol>
461 <ol><p>the image.</p></ol>
464 <ol><p>These values define the location of the pixel to return.</p></ol>
467 <ol><p>return any errors or warnings in this structure.</p></ol>
470 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
471 _8c.html" target="source" name="AcquirePixels">AcquirePixels</a></h2>
472 <div class="doc-section">
474 <p>AcquirePixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
476 <p>Deprecated, replace with:</p>
479 GetVirtualPixelQueue(image);
482 <p>The format of the AcquirePixels() method is:</p>
485 const PixelPacket *AcquirePixels(const Image image)
488 <p>A description of each parameter follows:</p></ol>
491 <ol><p>the image.</p></ol>
494 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
495 _8c.html" target="source" name="AffinityImage">AffinityImage</a></h2>
496 <div class="doc-section">
498 <p>AffinityImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
500 <p>Deprecated, replace with:</p>
503 RemapImage(quantize_info,image,affinity_image);
506 <p>The format of the AffinityImage method is:</p>
509 MagickBooleanType AffinityImage(const QuantizeInfo *quantize_info,
510 Image *image,const Image *affinity_image)
513 <p>A description of each parameter follows:</p></ol>
515 <h5>quantize_info</h5>
516 <ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
519 <ol><p>the image.</p></ol>
521 <h5>affinity_image</h5>
522 <ol><p>the reference image.</p></ol>
525 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
526 _8c.html" target="source" name="AffinityImages">AffinityImages</a></h2>
527 <div class="doc-section">
529 <p>AffinityImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
531 <p>Deprecated, replace with:</p>
534 RemapImages(quantize_info,images,affinity_image);
537 <p>The format of the AffinityImage method is:</p>
540 MagickBooleanType AffinityImages(const QuantizeInfo *quantize_info,
541 Image *images,Image *affinity_image)
544 <p>A description of each parameter follows:</p></ol>
546 <h5>quantize_info</h5>
547 <ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
550 <ol><p>the image sequence.</p></ol>
552 <h5>affinity_image</h5>
553 <ol><p>the reference image.</p></ol>
556 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
557 _8c.html" target="source" name="AllocateImage">AllocateImage</a></h2>
558 <div class="doc-section">
560 <p>AllocateImage() returns a pointer to an image structure initialized to default values.</p></ol>
562 <p>Deprecated, replace with:</p>
565 AcquireImage(image_info);
568 <p>The format of the AllocateImage method is:</p>
571 Image *AllocateImage(const ImageInfo *image_info)
574 <p>A description of each parameter follows:</p></ol>
577 <ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
580 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
581 _8c.html" target="source" name="AllocateImageColormap">AllocateImageColormap</a></h2>
582 <div class="doc-section">
584 <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>
586 <p>Deprecated, replace with:</p>
589 AcquireImageColormap(image,colors);
592 <p>The format of the AllocateImageColormap method is:</p>
595 MagickBooleanType AllocateImageColormap(Image *image,
599 <p>A description of each parameter follows:</p></ol>
602 <ol><p>the image.</p></ol>
605 <ol><p>the number of colors in the image colormap.</p></ol>
608 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
609 _8c.html" target="source" name="AllocateNextImage">AllocateNextImage</a></h2>
610 <div class="doc-section">
612 <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>
614 <p>Deprecated, replace with:</p>
617 AcquireNextImage(image_info,image);
620 <p>The format of the AllocateNextImage method is:</p>
623 void AllocateNextImage(const ImageInfo *image_info,Image *image)
626 <p>A description of each parameter follows:</p></ol>
629 <ol><p>Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.</p></ol>
632 <ol><p>the image.</p></ol>
635 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
636 _8c.html" target="source" name="AllocateString">AllocateString</a></h2>
637 <div class="doc-section">
639 <p>AllocateString() allocates memory for a string and copies the source string to that memory location (and returns it).</p></ol>
641 <p>The format of the AllocateString method is:</p>
644 char *AllocateString(const char *source)
647 <p>A description of each parameter follows:</p></ol>
650 <ol><p>A character string.</p></ol>
653 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
654 _8c.html" target="source" name="AverageImages">AverageImages</a></h2>
655 <div class="doc-section">
657 <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>
659 <p>Deprecated, replace with:</p>
662 EvaluateImages(images,MeanEvaluateOperator,exception);
665 <p>The format of the AverageImages method is:</p>
668 Image *AverageImages(Image *images,ExceptionInfo *exception)
671 <p>A description of each parameter follows:</p></ol>
674 <ol><p>the image sequence.</p></ol>
677 <ol><p>return any errors or warnings in this structure.</p></ol>
680 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
681 _8c.html" target="source" name="ChannelThresholdImage">ChannelThresholdImage</a></h2>
682 <div class="doc-section">
684 <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>
686 <p>The format of the ChannelThresholdImage method is:</p>
689 unsigned int ChannelThresholdImage(Image *image,const char *level)
692 <p>A description of each parameter follows:</p></ol>
695 <ol><p>the image.</p></ol>
698 <ol><p>define the threshold values.</p></ol>
701 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
702 _8c.html" target="source" name="ClipPathImage">ClipPathImage</a></h2>
703 <div class="doc-section">
705 <p>ClipPathImage() sets the image clip mask based any clipping path information if it exists.</p></ol>
707 <p>Deprecated, replace with:</p>
710 ClipImagePath(image,pathname,inside);
713 <p>The format of the ClipImage method is:</p>
716 MagickBooleanType ClipPathImage(Image *image,const char *pathname,
717 const MagickBooleanType inside)
720 <p>A description of each parameter follows:</p></ol>
723 <ol><p>the image.</p></ol>
726 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
729 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
732 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
733 _8c.html" target="source" name="CloneImageAttributes">CloneImageAttributes</a></h2>
734 <div class="doc-section">
736 <p>CloneImageAttributes() clones one or more image attributes.</p></ol>
738 <p>Deprecated, replace with:</p>
741 CloneImageProperties(image,clone_image);
744 <p>The format of the CloneImageAttributes method is:</p>
747 MagickBooleanType CloneImageAttributes(Image *image,
748 const Image *clone_image)
751 <p>A description of each parameter follows:</p></ol>
754 <ol><p>the image.</p></ol>
757 <ol><p>the clone image.</p></ol>
760 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
761 _8c.html" target="source" name="CloneMemory">CloneMemory</a></h2>
762 <div class="doc-section">
764 <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>
766 <p>The format of the CloneMemory method is:</p>
769 void *CloneMemory(void *destination,const void *source,
773 <p>A description of each parameter follows:</p></ol>
776 <ol><p>the destination.</p></ol>
779 <ol><p>the source.</p></ol>
782 <ol><p>the size of the memory in bytes to allocate.</p></ol>
785 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
786 _8c.html" target="source" name="CloseCacheView">CloseCacheView</a></h2>
787 <div class="doc-section">
789 <p>CloseCacheView() closes the specified view returned by a previous call to OpenCacheView().</p></ol>
791 <p>Deprecated, replace with:</p>
794 DestroyCacheView(view_info);
797 <p>The format of the CloseCacheView method is:</p>
800 CacheView *CloseCacheView(CacheView *view_info)
803 <p>A description of each parameter follows:</p></ol>
806 <ol><p>the address of a structure of type CacheView.</p></ol>
809 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
810 _8c.html" target="source" name="ColorFloodfill">ColorFloodfill</a></h2>
811 <div class="doc-section">
813 <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>
815 <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>
817 <p>The format of the ColorFloodfillImage method is:</p>
820 MagickBooleanType ColorFloodfillImage(Image *image,
821 const DrawInfo *draw_info,const PixelPacket target,
822 const ssize_t x_offset,const ssize_t y_offset,const PaintMethod method)
825 <p>A description of each parameter follows:</p></ol>
828 <ol><p>the image.</p></ol>
831 <ol><p>the draw info.</p></ol>
834 <ol><p>the RGB value of the target color.</p></ol>
837 <ol><p>the starting location of the operation.</p></ol>
840 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
843 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
844 _8c.html" target="source" name="DeleteImageAttribute">DeleteImageAttribute</a></h2>
845 <div class="doc-section">
847 <p>DeleteImageAttribute() deletes an attribute from the image.</p></ol>
849 <p>Deprecated, replace with:</p>
852 DeleteImageProperty(image,key);
855 <p>The format of the DeleteImageAttribute method is:</p>
858 MagickBooleanType DeleteImageAttribute(Image *image,const char *key)
861 <p>A description of each parameter follows:</p></ol>
864 <ol><p>the image info.</p></ol>
867 <ol><p>the image key.</p></ol>
870 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
871 _8c.html" target="source" name="DeleteImageList">DeleteImageList</a></h2>
872 <div class="doc-section">
874 <p>DeleteImageList() deletes an image at the specified position in the list.</p></ol>
876 <p>The format of the DeleteImageList method is:</p>
879 unsigned int DeleteImageList(Image *images,const ssize_t offset)
882 <p>A description of each parameter follows:</p></ol>
885 <ol><p>the image list.</p></ol>
888 <ol><p>the position within the list.</p></ol>
891 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
892 _8c.html" target="source" name="DeleteMagickRegistry">DeleteMagickRegistry</a></h2>
893 <div class="doc-section">
895 <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>
897 <p>Deprecated, replace with:</p>
900 char key[MaxTextExtent];
901 FormatMagickString(key,MaxTextExtent,"ld\n",id);
902 DeleteImageRegistry(key);
905 <p>The format of the DeleteMagickRegistry method is:</p>
908 MagickBooleanType DeleteMagickRegistry(const ssize_t id)
911 <p>A description of each parameter follows:</p></ol>
914 <ol><p>the registry id.</p></ol>
917 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
918 _8c.html" target="source" name="DescribeImage">DescribeImage</a></h2>
919 <div class="doc-section">
921 <p>DescribeImage() describes an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p></ol>
923 <p>Deprecated, replace with:</p>
926 IdentifyImage(image,file,verbose);
929 <p>The format of the DescribeImage method is:</p>
932 MagickBooleanType DescribeImage(Image *image,FILE *file,
933 const MagickBooleanType verbose)
936 <p>A description of each parameter follows:</p></ol>
939 <ol><p>the image.</p></ol>
942 <ol><p>the file, typically stdout.</p></ol>
945 <ol><p>A value other than zero prints more detailed information about the image.</p></ol>
948 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
949 _8c.html" target="source" name="DestroyImageAttributes">DestroyImageAttributes</a></h2>
950 <div class="doc-section">
952 <p>DestroyImageAttributes() deallocates memory associated with the image attribute list.</p></ol>
954 <p>The format of the DestroyImageAttributes method is:</p>
957 DestroyImageAttributes(Image *image)
960 <p>A description of each parameter follows:</p></ol>
963 <ol><p>the image.</p></ol>
966 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
967 _8c.html" target="source" name="DestroyImages">DestroyImages</a></h2>
968 <div class="doc-section">
970 <p>DestroyImages() destroys an image list.</p></ol>
972 <p>Deprecated, replace with:</p>
975 DestroyImageList(image);
978 <p>The format of the DestroyImages method is:</p>
981 void DestroyImages(Image *image)
984 <p>A description of each parameter follows:</p></ol>
987 <ol><p>the image sequence.</p></ol>
990 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
991 _8c.html" target="source" name="DestroyMagick">DestroyMagick</a></h2>
992 <div class="doc-section">
994 <p>DestroyMagick() destroys the ImageMagick environment.</p></ol>
996 <p>Deprecated, replace with:</p>
999 MagickCoreTerminus();
1002 <p>The format of the DestroyMagick function is:</p>
1009 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1010 _8c.html" target="source" name="DispatchImage">DispatchImage</a></h2>
1011 <div class="doc-section">
1013 <p>DispatchImage() extracts pixel data from an image and returns it to you. The method returns MagickFalse on success otherwise MagickTrue if an error is encountered. The data is returned as char, short int, int, ssize_t, float, or double in the order specified by map.</p></ol>
1015 <p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
1018 DispatchImage(image,0,0,640,1,"RGB",CharPixel,pixels,exception);
1021 <p>Deprecated, replace with:</p>
1024 ExportImagePixels(image,x_offset,y_offset,columns,rows,map,type,pixels,
1028 <p>The format of the DispatchImage method is:</p>
1031 unsigned int DispatchImage(const Image *image,const ssize_t x_offset,
1032 const ssize_t y_offset,const size_t columns,
1033 const size_t rows,const char *map,const StorageType type,
1034 void *pixels,ExceptionInfo *exception)
1037 <p>A description of each parameter follows:</p></ol>
1040 <ol><p>the image.</p></ol>
1042 <h5>x_offset, y_offset, columns, rows</h5>
1043 <ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
1046 <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>
1049 <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>
1052 <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>
1055 <ol><p>return any errors or warnings in this structure.</p></ol>
1058 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1059 _8c.html" target="source" name="ExtractSubimageFromImageImage">ExtractSubimageFromImageImage</a></h2>
1060 <div class="doc-section">
1062 <p>ExtractSubimageFromImageImage() extracts a region of the image that most closely resembles the reference.</p></ol>
1064 <p>The format of the ExtractSubimageFromImageImage method is:</p>
1067 Image *ExtractSubimageFromImage(const Image *image,
1068 const Image *reference,ExceptionInfo *exception)
1071 <p>A description of each parameter follows:</p></ol>
1074 <ol><p>the image.</p></ol>
1077 <ol><p>find an area of the image that closely resembles this image.</p></ol>
1080 <ol><p>return any errors or warnings in this structure.</p></ol>
1083 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1084 _8c.html" target="source" name="FlattenImages">FlattenImages</a></h2>
1085 <div class="doc-section">
1087 <p>FlattenImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
1089 <p>Deprecated, replace with:</p>
1092 MergeImageLayers(image,FlattenLayer,exception);
1095 <p>The format of the FlattenImage method is:</p>
1098 Image *FlattenImage(Image *image,ExceptionInfo *exception)
1101 <p>A description of each parameter follows:</p></ol>
1104 <ol><p>the image sequence.</p></ol>
1107 <ol><p>return any errors or warnings in this structure.</p></ol>
1110 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1111 _8c.html" target="source" name="FormatImageAttribute">FormatImageAttribute</a></h2>
1112 <div class="doc-section">
1114 <p>FormatImageAttribute() permits formatted key/value pairs to be saved as an image attribute.</p></ol>
1116 <p>The format of the FormatImageAttribute method is:</p>
1119 MagickBooleanType FormatImageAttribute(Image *image,const char *key,
1120 const char *format,...)
1123 <p>A description of each parameter follows.</p></ol>
1126 <ol><p>The image.</p></ol>
1129 <ol><p>The attribute key.</p></ol>
1132 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
1135 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1136 _8c.html" target="source" name="FormatString">FormatString</a></h2>
1137 <div class="doc-section">
1139 <p>FormatString() prints formatted output of a variable argument list.</p></ol>
1141 <p>The format of the FormatString method is:</p>
1144 void FormatString(char *string,const char *format,...)
1147 <p>A description of each parameter follows.</p></ol>
1150 <ol><p>Method FormatString returns the formatted string in this character buffer.</p></ol>
1153 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
1156 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1157 _8c.html" target="source" name="GetConfigureBlob">GetConfigureBlob</a></h2>
1158 <div class="doc-section">
1160 <p>GetConfigureBlob() returns the specified configure file as a blob.</p></ol>
1162 <p>The format of the GetConfigureBlob method is:</p>
1165 void *GetConfigureBlob(const char *filename,ExceptionInfo *exception)
1168 <p>A description of each parameter follows:</p></ol>
1171 <ol><p>the configure file name.</p></ol>
1174 <ol><p>return the full path information of the configure file.</p></ol>
1177 <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>
1180 <ol><p>return any errors or warnings in this structure.</p></ol>
1183 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1184 _8c.html" target="source" name="GetCacheView">GetCacheView</a></h2>
1185 <div class="doc-section">
1187 <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>
1189 <p>Deprecated, replace with:</p>
1192 GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
1193 GetCacheViewException(cache_view));
1196 <p>The format of the GetCacheView method is:</p>
1199 PixelPacket *GetCacheView(CacheView *cache_view,const ssize_t x,
1200 const ssize_t y,const size_t columns,const size_t rows)
1203 <p>A description of each parameter follows:</p></ol>
1206 <ol><p>the address of a structure of type CacheView.</p></ol>
1208 <h5>x,y,columns,rows</h5>
1209 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1212 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1213 _8c.html" target="source" name="GetCacheViewIndexes">GetCacheViewIndexes</a></h2>
1214 <div class="doc-section">
1216 <p>GetCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
1218 <p>Deprecated, replace with:</p>
1221 GetCacheViewAuthenticIndexQueue(cache_view);
1224 <p>The format of the GetCacheViewIndexes method is:</p>
1227 IndexPacket *GetCacheViewIndexes(CacheView *cache_view)
1230 <p>A description of each parameter follows:</p></ol>
1233 <ol><p>the cache view.</p></ol>
1236 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1237 _8c.html" target="source" name="GetCacheViewPixels">GetCacheViewPixels</a></h2>
1238 <div class="doc-section">
1240 <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>
1242 <p>Deprecated, replace with:</p>
1245 GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
1246 GetCacheViewException(cache_view));
1249 <p>The format of the GetCacheViewPixels method is:</p>
1252 PixelPacket *GetCacheViewPixels(CacheView *cache_view,const ssize_t x,
1253 const ssize_t y,const size_t columns,const size_t rows)
1256 <p>A description of each parameter follows:</p></ol>
1259 <ol><p>the cache view.</p></ol>
1261 <h5>x,y,columns,rows</h5>
1262 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1265 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1266 _8c.html" target="source" name="GetImageAttribute">GetImageAttribute</a></h2>
1267 <div class="doc-section">
1269 <p>GetImageAttribute() searches the list of image attributes and returns a pointer to the attribute if it exists otherwise NULL.</p></ol>
1271 <p>The format of the GetImageAttribute method is:</p>
1274 const ImageAttribute *GetImageAttribute(const Image *image,
1278 <p>A description of each parameter follows:</p></ol>
1281 <ol><p>the image.</p></ol>
1284 <ol><p>These character strings are the name of an image attribute to return.</p></ol>
1287 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1288 _8c.html" target="source" name="GetImageClippingPathAttribute">GetImageClippingPathAttribute</a></h2>
1289 <div class="doc-section">
1291 <p>GetImageClippingPathAttribute() searches the list of image attributes and returns a pointer to a clipping path if it exists otherwise NULL.</p></ol>
1293 <p>Deprecated, replace with:</p>
1296 GetImageAttribute(image,"8BIM:1999,2998");
1299 <p>The format of the GetImageClippingPathAttribute method is:</p>
1302 const ImageAttribute *GetImageClippingPathAttribute(Image *image)
1305 <p>A description of each parameter follows:</p></ol>
1308 <ol><p>Method GetImageClippingPathAttribute returns the clipping path if it exists otherwise NULL.</p></ol>
1311 <ol><p>the image.</p></ol>
1314 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1315 _8c.html" target="source" name="GetImageFromMagickRegistry">GetImageFromMagickRegistry</a></h2>
1316 <div class="doc-section">
1318 <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>
1320 <p>Deprecated, replace with:</p>
1323 GetImageRegistry(ImageRegistryType,name,exception);
1326 <p>The format of the GetImageFromMagickRegistry method is:</p>
1329 Image *GetImageFromMagickRegistry(const char *name,ssize_t *id,
1330 ExceptionInfo *exception)
1333 <p>A description of each parameter follows:</p></ol>
1336 <ol><p>the name of the image to retrieve from the registry.</p></ol>
1339 <ol><p>the registry id.</p></ol>
1342 <ol><p>return any errors or warnings in this structure.</p></ol>
1345 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1346 _8c.html" target="source" name="GetMagickRegistry">GetMagickRegistry</a></h2>
1347 <div class="doc-section">
1349 <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>
1351 <p>The format of the GetMagickRegistry method is:</p>
1354 const void *GetMagickRegistry(const ssize_t id,RegistryType *type,
1355 size_t *length,ExceptionInfo *exception)
1358 <p>A description of each parameter follows:</p></ol>
1361 <ol><p>the registry id.</p></ol>
1364 <ol><p>the registry type.</p></ol>
1367 <ol><p>the blob length in number of bytes.</p></ol>
1370 <ol><p>return any errors or warnings in this structure.</p></ol>
1373 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1374 _8c.html" target="source" name="GetImageGeometry">GetImageGeometry</a></h2>
1375 <div class="doc-section">
1377 <p>GetImageGeometry() returns a region as defined by the geometry string with respect to the image and its gravity.</p></ol>
1379 <p>Deprecated, replace with:</p>
1382 if (size_to_fit != MagickFalse)
1383 ParseRegionGeometry(image,geometry,region_info,&image->exception); else
1384 ParsePageGeometry(image,geometry,region_info,&image->exception);
1387 <p>The format of the GetImageGeometry method is:</p>
1390 int GetImageGeometry(Image *image,const char *geometry,
1391 const unsigned int size_to_fit,RectangeInfo *region_info)
1394 <p>A description of each parameter follows:</p></ol>
1397 <ol><p>Method GetImageGeometry returns a bitmask that indicates which of the four values were located in the geometry string.</p></ol>
1400 <ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
1402 <h5>size_to_fit</h5>
1403 <ol><p>A value other than 0 means to scale the region so it fits within the specified width and height.</p></ol>
1405 <h5>region_info</h5>
1406 <ol><p>the region as defined by the geometry string with respect to the image and its gravity.</p></ol>
1409 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1410 _8c.html" target="source" name="GetImageList">GetImageList</a></h2>
1411 <div class="doc-section">
1413 <p>GetImageList() returns an image at the specified position in the list.</p></ol>
1415 <p>Deprecated, replace with:</p>
1418 CloneImage(GetImageFromList(images,(ssize_t) offset),0,0,MagickTrue,
1422 <p>The format of the GetImageList method is:</p>
1425 Image *GetImageList(const Image *images,const ssize_t offset,
1426 ExceptionInfo *exception)
1429 <p>A description of each parameter follows:</p></ol>
1432 <ol><p>the image list.</p></ol>
1435 <ol><p>the position within the list.</p></ol>
1438 <ol><p>return any errors or warnings in this structure.</p></ol>
1441 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1442 _8c.html" target="source" name="GetImageListIndex">GetImageListIndex</a></h2>
1443 <div class="doc-section">
1445 <p>GetImageListIndex() returns the position in the list of the specified image.</p></ol>
1447 <p>Deprecated, replace with:</p>
1450 GetImageIndexInList(images);
1453 <p>The format of the GetImageListIndex method is:</p>
1456 ssize_t GetImageListIndex(const Image *images)
1459 <p>A description of each parameter follows:</p></ol>
1462 <ol><p>the image list.</p></ol>
1465 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1466 _8c.html" target="source" name="GetImageListSize">GetImageListSize</a></h2>
1467 <div class="doc-section">
1469 <p>GetImageListSize() returns the number of images in the list.</p></ol>
1471 <p>Deprecated, replace with:</p>
1474 GetImageListLength(images);
1477 <p>The format of the GetImageListSize method is:</p>
1480 size_t GetImageListSize(const Image *images)
1483 <p>A description of each parameter follows:</p></ol>
1486 <ol><p>the image list.</p></ol>
1489 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1490 _8c.html" target="source" name="GetImagePixels">GetImagePixels</a></h2>
1491 <div class="doc-section">
1493 <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>
1495 <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>
1497 <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>
1499 <p>Deprecated, replace with:</p>
1502 GetAuthenticPixels(image,x,y,columns,rows,&image->exception);
1505 <p>The format of the GetImagePixels() method is:</p>
1508 PixelPacket *GetImagePixels(Image *image,const ssize_t x,const ssize_t y,
1509 const size_t columns,const size_t rows)
1512 <p>A description of each parameter follows:</p></ol>
1515 <ol><p>the image.</p></ol>
1517 <h5>x,y,columns,rows</h5>
1518 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1521 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1522 _8c.html" target="source" name="GetIndexes">GetIndexes</a></h2>
1523 <div class="doc-section">
1525 <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>
1527 <p>Deprecated, replace with:</p>
1530 GetAuthenticIndexQueue(image);
1533 <p>The format of the GetIndexes() method is:</p>
1536 IndexPacket *GetIndexes(const Image *image)
1539 <p>A description of each parameter follows:</p></ol>
1542 <ol><p>GetIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1545 <ol><p>the image.</p></ol>
1548 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1549 _8c.html" target="source" name="GetNextImage">GetNextImage</a></h2>
1550 <div class="doc-section">
1552 <p>GetNextImage() returns the next image in a list.</p></ol>
1554 <p>Deprecated, replace with:</p>
1557 GetNextImageInList(images);
1560 <p>The format of the GetNextImage method is:</p>
1563 Image *GetNextImage(const Image *images)
1566 <p>A description of each parameter follows:</p></ol>
1569 <ol><p>the image list.</p></ol>
1572 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1573 _8c.html" target="source" name="GetNextImageAttribute">GetNextImageAttribute</a></h2>
1574 <div class="doc-section">
1576 <p>GetNextImageAttribute() gets the next image attribute.</p></ol>
1578 <p>Deprecated, replace with:</p>
1581 const char *property;
1582 property=GetNextImageProperty(image);
1583 if (property != (const char *) NULL)
1584 GetImageAttribute(image,property);
1587 <p>The format of the GetNextImageAttribute method is:</p>
1590 const ImageAttribute *GetNextImageAttribute(const Image *image)
1593 <p>A description of each parameter follows:</p></ol>
1596 <ol><p>the image.</p></ol>
1599 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1600 _8c.html" target="source" name="GetNumberScenes">GetNumberScenes</a></h2>
1601 <div class="doc-section">
1603 <p>GetNumberScenes() returns the number of images in the list.</p></ol>
1605 <p>Deprecated, replace with:</p>
1608 GetImageListLength(image);
1611 <p>The format of the GetNumberScenes method is:</p>
1614 unsigned int GetNumberScenes(const Image *images)
1617 <p>A description of each parameter follows:</p></ol>
1620 <ol><p>the image list.</p></ol>
1623 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1624 _8c.html" target="source" name="GetOnePixel">GetOnePixel</a></h2>
1625 <div class="doc-section">
1627 <p>GetOnePixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
1629 <p>Deprecated, replace with:</p>
1632 GetOneAuthenticPixel(image,x,y,&pixel,&image->exception);
1635 <p>The format of the GetOnePixel() method is:</p>
1638 PixelPacket GetOnePixel(const Image image,const ssize_t x,const ssize_t y)
1641 <p>A description of each parameter follows:</p></ol>
1644 <ol><p>the image.</p></ol>
1647 <ol><p>These values define the location of the pixel to return.</p></ol>
1650 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1651 _8c.html" target="source" name="GetPixels">GetPixels</a></h2>
1652 <div class="doc-section">
1654 <p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1656 <p>Deprecated, replace with:</p>
1659 GetAuthenticPixelQueue(image);
1662 <p>The format of the GetPixels() method is:</p>
1665 PixelPacket *GetPixels(const Image image)
1668 <p>A description of each parameter follows:</p></ol>
1671 <ol><p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1674 <ol><p>the image.</p></ol>
1677 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1678 _8c.html" target="source" name="GetPreviousImage">GetPreviousImage</a></h2>
1679 <div class="doc-section">
1681 <p>GetPreviousImage() returns the previous image in a list.</p></ol>
1683 <p>Deprecated, replace with:</p>
1686 GetPreviousImageInList(images));
1689 <p>The format of the GetPreviousImage method is:</p>
1692 Image *GetPreviousImage(const Image *images)
1695 <p>A description of each parameter follows:</p></ol>
1698 <ol><p>the image list.</p></ol>
1701 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1702 _8c.html" target="source" name="HSLTransform">HSLTransform</a></h2>
1703 <div class="doc-section">
1705 <p>HSLTransform() converts a (hue, saturation, lightness) to a (red, green, blue) triple.</p></ol>
1707 <p>The format of the HSLTransformImage method is:</p>
1710 void HSLTransform(const double hue,const double saturation,
1711 const double lightness,Quantum *red,Quantum *green,Quantum *blue)
1714 <p>A description of each parameter follows:</p></ol>
1716 <h5>hue, saturation, lightness</h5>
1717 <ol><p>A double value representing a component of the HSL color space.</p></ol>
1719 <h5>red, green, blue</h5>
1720 <ol><p>A pointer to a pixel component of type Quantum.</p></ol>
1723 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1724 _8c.html" target="source" name="IdentityAffine">IdentityAffine</a></h2>
1725 <div class="doc-section">
1727 <p>IdentityAffine() initializes the affine transform to the identity matrix.</p></ol>
1729 <p>The format of the IdentityAffine method is:</p>
1732 IdentityAffine(AffineMatrix *affine)
1735 <p>A description of each parameter follows:</p></ol>
1738 <ol><p>A pointer the affine transform of type AffineMatrix.</p></ol>
1741 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1742 _8c.html" target="source" name="InitializeMagick">InitializeMagick</a></h2>
1743 <div class="doc-section">
1745 <p>InitializeMagick() initializes the ImageMagick environment.</p></ol>
1747 <p>Deprecated, replace with:</p>
1750 MagickCoreGenesis(path,MagickFalse);
1753 <p>The format of the InitializeMagick function is:</p>
1756 InitializeMagick(const char *path)
1759 <p>A description of each parameter follows:</p></ol>
1762 <ol><p>the execution path of the current ImageMagick client.</p></ol>
1765 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1766 _8c.html" target="source" name="InterpolatePixelColor">InterpolatePixelColor</a></h2>
1767 <div class="doc-section">
1769 <p>InterpolatePixelColor() applies bi-linear or tri-linear interpolation between a pixel and it's neighbors.</p></ol>
1771 <p>The format of the InterpolatePixelColor method is:</p>
1774 MagickPixelPacket InterpolatePixelColor(const Image *image,
1775 CacheView *view_info,InterpolatePixelMethod method,const double x,
1776 const double y,ExceptionInfo *exception)
1779 <p>A description of each parameter follows:</p></ol>
1782 <ol><p>the image.</p></ol>
1785 <ol><p>the image cache view.</p></ol>
1788 <ol><p>the type of pixel color interpolation.</p></ol>
1791 <ol><p>A double representing the current (x,y) position of the pixel.</p></ol>
1794 <ol><p>return any errors or warnings in this structure.</p></ol>
1797 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1798 _8c.html" target="source" name="InterpretImageAttributes">InterpretImageAttributes</a></h2>
1799 <div class="doc-section">
1801 <p>InterpretImageAttributes() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
1803 <p>Deprecated, replace with:</p>
1806 InterpretImageProperties(image_info,image,embed_text);
1809 <p>The format of the InterpretImageAttributes method is:</p>
1812 char *InterpretImageAttributes(const ImageInfo *image_info,Image *image,
1813 const char *embed_text)
1816 <p>A description of each parameter follows:</p></ol>
1819 <ol><p>the image info.</p></ol>
1822 <ol><p>the image.</p></ol>
1825 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
1828 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1829 _8c.html" target="source" name="LevelImageColor">LevelImageColor</a></h2>
1830 <div class="doc-section">
1832 <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>
1834 <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>
1836 <p>Deprecated, replace with:</p>
1839 LevelColorsImageChannel(image,channel,black_color,white_color,invert);
1842 <p>The format of the LevelImageColors method is:</p>
1845 MagickBooleanType LevelImageColors(Image *image,const ChannelType channel,
1846 const MagickPixelPacket *black_color,const MagickPixelPacket *white_color,
1847 const MagickBooleanType invert)
1850 <p>A description of each parameter follows:</p></ol>
1853 <ol><p>the image.</p></ol>
1856 <ol><p>the channel.</p></ol>
1858 <h5>black_color</h5>
1859 <ol><p>The color to map black to/from</p></ol>
1861 <h5>white_point</h5>
1862 <ol><p>The color to map white to/from</p></ol>
1865 <ol><p>if true map the colors (levelize), rather than from (level)</p></ol>
1868 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1869 _8c.html" target="source" name="LiberateMemory">LiberateMemory</a></h2>
1870 <div class="doc-section">
1872 <p>LiberateMemory() frees memory that has already been allocated, and NULL's the pointer to it.</p></ol>
1874 <p>The format of the LiberateMemory method is:</p>
1877 void LiberateMemory(void **memory)
1880 <p>A description of each parameter follows:</p></ol>
1883 <ol><p>A pointer to a block of memory to free for reuse.</p></ol>
1886 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1887 _8c.html" target="source" name="LiberateSemaphoreInfo">LiberateSemaphoreInfo</a></h2>
1888 <div class="doc-section">
1890 <p>LiberateSemaphoreInfo() relinquishes a semaphore.</p></ol>
1892 <p>Deprecated, replace with:</p>
1895 UnlockSemaphoreInfo(*semaphore_info);
1898 <p>The format of the LiberateSemaphoreInfo method is:</p>
1901 LiberateSemaphoreInfo(void **semaphore_info)
1904 <p>A description of each parameter follows:</p></ol>
1906 <h5>semaphore_info</h5>
1907 <ol><p>Specifies a pointer to an SemaphoreInfo structure.</p></ol>
1910 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1911 _8c.html" target="source" name="MagickIncarnate">MagickIncarnate</a></h2>
1912 <div class="doc-section">
1914 <p>MagickIncarnate() initializes the ImageMagick environment.</p></ol>
1916 <p>Deprecated, replace with:</p>
1919 MagickCoreGenesis(path,MagickFalse);
1922 <p>The format of the MagickIncarnate function is:</p>
1925 MagickIncarnate(const char *path)
1928 <p>A description of each parameter follows:</p></ol>
1931 <ol><p>the execution path of the current ImageMagick client.</p></ol>
1934 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1935 _8c.html" target="source" name="MagickMonitor">MagickMonitor</a></h2>
1936 <div class="doc-section">
1938 <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>
1940 <p>The format of the MagickMonitor method is:</p>
1943 MagickBooleanType MagickMonitor(const char *text,
1944 const MagickOffsetType offset,const MagickSizeType span,
1948 <p>A description of each parameter follows:</p></ol>
1951 <ol><p>the position relative to the span parameter which represents how much progress has been made toward completing a task.</p></ol>
1954 <ol><p>the span relative to completing a task.</p></ol>
1956 <h5>client_data</h5>
1957 <ol><p>the client data.</p></ol>
1960 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1961 _8c.html" target="source" name="MapImage">MapImage</a></h2>
1962 <div class="doc-section">
1964 <p>MapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
1966 <p>Deprecated, replace with:</p>
1969 QuantizeInfo quantize_info;
1970 GetQuantizeInfo(&quantize_info);
1971 quantize_info.dither=dither;
1972 RemapImage(&quantize_info,image,map_image);
1975 <p>The format of the MapImage method is:</p>
1978 MagickBooleanType MapImage(Image *image,const Image *map_image,
1979 const MagickBooleanType dither)
1982 <p>A description of each parameter follows:</p></ol>
1985 <ol><p>Specifies a pointer to an Image structure.</p></ol>
1988 <ol><p>the image. Reduce image to a set of colors represented by this image.</p></ol>
1991 <ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
1994 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1995 _8c.html" target="source" name="MapImages">MapImages</a></h2>
1996 <div class="doc-section">
1998 <p>MapImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
2000 <p>Deprecated, replace with:</p>
2003 QuantizeInfo quantize_info;
2004 GetQuantizeInfo(&quantize_info);
2005 quantize_info.dither=dither;
2006 RemapImages(&quantize_info,images,map_image);
2009 <p>The format of the MapImage method is:</p>
2012 MagickBooleanType MapImages(Image *images,Image *map_image,
2013 const MagickBooleanType dither)
2016 <p>A description of each parameter follows:</p></ol>
2019 <ol><p>Specifies a pointer to a set of Image structures.</p></ol>
2022 <ol><p>the image. Reduce image to a set of colors represented by this image.</p></ol>
2025 <ol><p>Set this integer value to something other than zero to dither the quantized image.</p></ol>
2028 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2029 _8c.html" target="source" name="MatteFloodfill">MatteFloodfill</a></h2>
2030 <div class="doc-section">
2032 <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>
2034 <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>
2036 <p>The format of the MatteFloodfillImage method is:</p>
2039 MagickBooleanType MatteFloodfillImage(Image *image,
2040 const PixelPacket target,const Quantum opacity,const ssize_t x_offset,
2041 const ssize_t y_offset,const PaintMethod method)
2044 <p>A description of each parameter follows:</p></ol>
2047 <ol><p>the image.</p></ol>
2050 <ol><p>the RGB value of the target color.</p></ol>
2053 <ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
2056 <ol><p>the starting location of the operation.</p></ol>
2059 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
2062 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2063 _8c.html" target="source" name="MaximumImages">MaximumImages</a></h2>
2064 <div class="doc-section">
2066 <p>MaximumImages() returns the maximum intensity of an image sequence.</p></ol>
2068 <p>Deprecated, replace with:</p>
2071 EvaluateImages(images,MinEvaluateOperator,exception);
2074 <p>The format of the MaxImages method is:</p>
2077 Image *MaximumImages(Image *images,ExceptionInfo *exception)
2080 <p>A description of each parameter follows:</p></ol>
2083 <ol><p>the image sequence.</p></ol>
2086 <ol><p>return any errors or warnings in this structure.</p></ol>
2089 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2090 _8c.html" target="source" name="MinimumImages">MinimumImages</a></h2>
2091 <div class="doc-section">
2093 <p>MinimumImages() returns the minimum intensity of an image sequence.</p></ol>
2095 <p>Deprecated, replace with:</p>
2098 EvaluateImages(images,MinEvaluateOperator,exception);
2101 <p>The format of the MinimumImages method is:</p>
2104 Image *MinimumImages(Image *images,ExceptionInfo *exception)
2107 <p>A description of each parameter follows:</p></ol>
2110 <ol><p>the image sequence.</p></ol>
2113 <ol><p>return any errors or warnings in this structure.</p></ol>
2116 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2117 _8c.html" target="source" name="MosaicImages">MosaicImages</a></h2>
2118 <div class="doc-section">
2120 <p>MosaicImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
2122 <p>Deprecated, replace with:</p>
2125 MergeImageLayers(image,MosaicLayer,exception);
2128 <p>The format of the MosaicImage method is:</p>
2131 Image *MosaicImages(const Image *image,ExceptionInfo *exception)
2134 <p>A description of each parameter follows:</p></ol>
2137 <ol><p>the image list to be composited together</p></ol>
2140 <ol><p>return any errors or warnings in this structure.</p></ol>
2143 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2144 _8c.html" target="source" name="OpaqueImage">OpaqueImage</a></h2>
2145 <div class="doc-section">
2147 <p>OpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
2149 <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>
2151 <p>The format of the OpaqueImage method is:</p>
2154 MagickBooleanType OpaqueImage(Image *image,
2155 const PixelPacket *target,const PixelPacket fill)
2158 <p>A description of each parameter follows:</p></ol>
2161 <ol><p>the image.</p></ol>
2164 <ol><p>the RGB value of the target color.</p></ol>
2167 <ol><p>the replacement color.</p></ol>
2170 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2171 _8c.html" target="source" name="OpenCacheView">OpenCacheView</a></h2>
2172 <div class="doc-section">
2174 <p>OpenCacheView() opens a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
2176 <p>Deprecated, replace with:</p>
2179 AcquireCacheView(image);
2182 <p>The format of the OpenCacheView method is:</p>
2185 CacheView *OpenCacheView(const Image *image)
2188 <p>A description of each parameter follows:</p></ol>
2191 <ol><p>the image.</p></ol>
2194 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2195 _8c.html" target="source" name="PaintFloodfill">PaintFloodfill</a></h2>
2196 <div class="doc-section">
2198 <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>
2200 <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>
2202 <p>Deprecated, replace with:</p>
2205 FloodfillPaintImage(image,channel,draw_info,target,x,y,
2206 method == FloodfillMethod ? MagickFalse : MagickTrue);
2209 <p>The format of the PaintFloodfillImage method is:</p>
2212 MagickBooleanType PaintFloodfillImage(Image *image,
2213 const ChannelType channel,const MagickPixelPacket target,const ssize_t x,
2214 const ssize_t y,const DrawInfo *draw_info,const PaintMethod method)
2217 <p>A description of each parameter follows:</p></ol>
2220 <ol><p>the image.</p></ol>
2223 <ol><p>the channel(s).</p></ol>
2226 <ol><p>the RGB value of the target color.</p></ol>
2229 <ol><p>the starting location of the operation.</p></ol>
2232 <ol><p>the draw info.</p></ol>
2235 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
2238 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2239 _8c.html" target="source" name="PaintOpaqueImage">PaintOpaqueImage</a></h2>
2240 <div class="doc-section">
2242 <p>PaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
2244 <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>
2246 <p>Deprecated, replace with:</p>
2249 OpaquePaintImageChannel(image,DefaultChannels,target,fill,MagickFalse);
2250 OpaquePaintImageChannel(image,channel,target,fill,MagickFalse);
2253 <p>The format of the PaintOpaqueImage method is:</p>
2256 MagickBooleanType PaintOpaqueImage(Image *image,
2257 const PixelPacket *target,const PixelPacket *fill)
2258 MagickBooleanType PaintOpaqueImageChannel(Image *image,
2259 const ChannelType channel,const PixelPacket *target,
2260 const PixelPacket *fill)
2263 <p>A description of each parameter follows:</p></ol>
2266 <ol><p>the image.</p></ol>
2269 <ol><p>the channel(s).</p></ol>
2272 <ol><p>the RGB value of the target color.</p></ol>
2275 <ol><p>the replacement color.</p></ol>
2278 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2279 _8c.html" target="source" name="PaintTransparentImage">PaintTransparentImage</a></h2>
2280 <div class="doc-section">
2282 <p>PaintTransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
2284 <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>
2286 <p>Deprecated, replace with:</p>
2289 TransparentPaintImage(image,target,opacity,MagickFalse);
2292 <p>The format of the PaintTransparentImage method is:</p>
2295 MagickBooleanType PaintTransparentImage(Image *image,
2296 const MagickPixelPacket *target,const Quantum opacity)
2299 <p>A description of each parameter follows:</p></ol>
2302 <ol><p>the image.</p></ol>
2305 <ol><p>the RGB value of the target color.</p></ol>
2308 <ol><p>the replacement opacity value.</p></ol>
2311 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2312 _8c.html" target="source" name="ParseSizeGeometry">ParseSizeGeometry</a></h2>
2313 <div class="doc-section">
2315 <p>ParseSizeGeometry() returns a region as defined by the geometry string with respect to the image dimensions and aspect ratio.</p></ol>
2317 <p>Deprecated, replace with:</p>
2320 ParseMetaGeometry(geometry,®ion_info->x,®ion_info->y,
2321 ®ion_info->width,®ion_info->height);
2324 <p>The format of the ParseSizeGeometry method is:</p>
2327 MagickStatusType ParseSizeGeometry(const Image *image,
2328 const char *geometry,RectangeInfo *region_info)
2331 <p>A description of each parameter follows:</p></ol>
2334 <ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
2336 <h5>region_info</h5>
2337 <ol><p>the region as defined by the geometry string.</p></ol>
2340 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2341 _8c.html" target="source" name="PopImageList">PopImageList</a></h2>
2342 <div class="doc-section">
2344 <p>PopImageList() removes the last image in the list.</p></ol>
2346 <p>Deprecated, replace with:</p>
2349 RemoveLastImageFromList(images);
2352 <p>The format of the PopImageList method is:</p>
2355 Image *PopImageList(Image **images)
2358 <p>A description of each parameter follows:</p></ol>
2361 <ol><p>the image list.</p></ol>
2364 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2365 _8c.html" target="source" name="PopImagePixels">PopImagePixels</a></h2>
2366 <div class="doc-section">
2368 <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>
2370 <p>The format of the PopImagePixels method is:</p>
2373 size_t PopImagePixels(Image *,const QuantumType quantum,
2374 unsigned char *destination)
2377 <p>A description of each parameter follows:</p></ol>
2380 <ol><p>the image.</p></ol>
2383 <ol><p>Declare which pixel components to transfer (RGB, RGBA, etc).</p></ol>
2385 <h5>destination</h5>
2386 <ol><p>The components are transferred to this buffer.</p></ol>
2389 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2390 _8c.html" target="source" name="PostscriptGeometry">PostscriptGeometry</a></h2>
2391 <div class="doc-section">
2393 <p>PostscriptGeometry() replaces any page mneumonic with the equivalent size in picas.</p></ol>
2395 <p>Deprecated, replace with:</p>
2398 GetPageGeometry(page);
2401 <p>The format of the PostscriptGeometry method is:</p>
2404 char *PostscriptGeometry(const char *page)
2407 <p>A description of each parameter follows.</p></ol>
2410 <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>
2413 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2414 _8c.html" target="source" name="PushImageList">PushImageList</a></h2>
2415 <div class="doc-section">
2417 <p>PushImageList() adds an image to the end of the list.</p></ol>
2419 <p>Deprecated, replace with:</p>
2422 AppendImageToList(images,CloneImageList(image,exception));
2425 <p>The format of the PushImageList method is:</p>
2428 unsigned int PushImageList(Image *images,const Image *image,
2429 ExceptionInfo *exception)
2432 <p>A description of each parameter follows:</p></ol>
2435 <ol><p>the image list.</p></ol>
2438 <ol><p>the image.</p></ol>
2441 <ol><p>return any errors or warnings in this structure.</p></ol>
2444 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2445 _8c.html" target="source" name="PushImagePixels">PushImagePixels</a></h2>
2446 <div class="doc-section">
2448 <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>
2450 <p>The format of the PushImagePixels method is:</p>
2453 size_t PushImagePixels(Image *image,const QuantumType quantum,
2454 const unsigned char *source)
2457 <p>A description of each parameter follows:</p></ol>
2460 <ol><p>the image.</p></ol>
2463 <ol><p>Declare which pixel components to transfer (red, green, blue, opacity, RGB, or RGBA).</p></ol>
2466 <ol><p>The pixel components are transferred from this buffer.</p></ol>
2469 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2470 _8c.html" target="source" name="QuantizationError">QuantizationError</a></h2>
2471 <div class="doc-section">
2473 <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>
2476 o mean_error_per_pixel: This value is the mean error for any single
2480 <h5>normalized_mean_square_error</h5>
2481 <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>
2483 <h5>normalized_maximum_square_error</h5>
2484 <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>
2486 <p>Deprecated, replace with:</p>
2489 GetImageQuantizeError(image);
2492 <p>The format of the QuantizationError method is:</p>
2495 unsigned int QuantizationError(Image *image)
2498 <p>A description of each parameter follows.</p></ol>
2501 <ol><p>Specifies a pointer to an Image structure; returned from ReadImage.</p></ol>
2504 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2505 _8c.html" target="source" name="RandomChannelThresholdImage">RandomChannelThresholdImage</a></h2>
2506 <div class="doc-section">
2508 <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>
2510 <p>The format of the RandomChannelThresholdImage method is:</p>
2513 unsigned int RandomChannelThresholdImage(Image *image,
2514 const char *channel, const char *thresholds,
2515 ExceptionInfo *exception)
2518 <p>A description of each parameter follows:</p></ol>
2521 <ol><p>the image.</p></ol>
2524 <ol><p>the channel or channels to be thresholded.</p></ol>
2527 <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>
2530 <ol><p>return any errors or warnings in this structure.</p></ol>
2533 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2534 _8c.html" target="source" name="ReacquireMemory">ReacquireMemory</a></h2>
2535 <div class="doc-section">
2537 <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>
2539 <p>The format of the ReacquireMemory method is:</p>
2542 void ReacquireMemory(void **memory,const size_t size)
2545 <p>A description of each parameter follows:</p></ol>
2548 <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>
2551 <ol><p>the new size of the allocated memory.</p></ol>
2554 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2555 _8c.html" target="source" name="RecolorImage">RecolorImage</a></h2>
2556 <div class="doc-section">
2558 <p>RecolorImage() apply color transformation to an image. The method permits saturation changes, hue rotation, luminance to alpha, and various other effects. Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255).</p></ol>
2560 <p>The format of the RecolorImage method is:</p>
2563 Image *RecolorImage(const Image *image,const size_t order,
2564 const double *color_matrix,ExceptionInfo *exception)
2567 <p>A description of each parameter follows:</p></ol>
2570 <ol><p>the image.</p></ol>
2573 <ol><p>the number of columns and rows in the recolor matrix.</p></ol>
2575 <h5>color_matrix</h5>
2576 <ol><p>An array of double representing the recolor matrix.</p></ol>
2579 <ol><p>return any errors or warnings in this structure.</p></ol>
2582 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2583 _8c.html" target="source" name="ResetImageAttributeIterator">ResetImageAttributeIterator</a></h2>
2584 <div class="doc-section">
2586 <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>
2588 <p>Deprecated, replace with:</p>
2591 ResetImagePropertyIterator(image);
2594 <p>The format of the ResetImageAttributeIterator method is:</p>
2597 ResetImageAttributeIterator(const ImageInfo *image)
2600 <p>A description of each parameter follows:</p></ol>
2603 <ol><p>the image.</p></ol>
2606 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2607 _8c.html" target="source" name="SetCacheViewPixels">SetCacheViewPixels</a></h2>
2608 <div class="doc-section">
2610 <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>
2612 <p>Deprecated, replace with:</p>
2615 QueueCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
2616 GetCacheViewException(cache_view));
2619 <p>The format of the SetCacheViewPixels method is:</p>
2622 PixelPacket *SetCacheViewPixels(CacheView *cache_view,const ssize_t x,
2623 const ssize_t y,const size_t columns,const size_t rows)
2626 <p>A description of each parameter follows:</p></ol>
2629 <ol><p>the cache view.</p></ol>
2631 <h5>x,y,columns,rows</h5>
2632 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
2635 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2636 _8c.html" target="source" name="SetExceptionInfo">SetExceptionInfo</a></h2>
2637 <div class="doc-section">
2639 <p>SetExceptionInfo() sets the exception severity.</p></ol>
2641 <p>The format of the SetExceptionInfo method is:</p>
2644 MagickBooleanType SetExceptionInfo(ExceptionInfo *exception,
2645 ExceptionType severity)
2648 <p>A description of each parameter follows:</p></ol>
2651 <ol><p>the exception info.</p></ol>
2654 <ol><p>the exception severity.</p></ol>
2657 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2658 _8c.html" target="source" name="SetImage">SetImage</a></h2>
2659 <div class="doc-section">
2661 <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>
2663 <p>The format of the SetImage method is:</p>
2666 void SetImage(Image *image,const Quantum opacity)
2669 <p>A description of each parameter follows:</p></ol>
2672 <ol><p>the image.</p></ol>
2675 <ol><p>Set each pixel to this level of transparency.</p></ol>
2678 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2679 _8c.html" target="source" name="SetImageAttribute">SetImageAttribute</a></h2>
2680 <div class="doc-section">
2682 <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>
2684 <p>Deprecated, replace with:</p>
2687 SetImageProperty(image,key,value);
2690 <p>The format of the SetImageAttribute method is:</p>
2693 MagickBooleanType SetImageAttribute(Image *image,const char *key,
2697 <p>A description of each parameter follows:</p></ol>
2700 <ol><p>the image.</p></ol>
2703 <ol><p>the key.</p></ol>
2706 <ol><p>the value.</p></ol>
2709 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2710 _8c.html" target="source" name="SetImageList">SetImageList</a></h2>
2711 <div class="doc-section">
2713 <p>SetImageList() inserts an image into the list at the specified position.</p></ol>
2715 <p>The format of the SetImageList method is:</p>
2718 unsigned int SetImageList(Image *images,const Image *image,
2719 const ssize_t offset,ExceptionInfo *exception)
2722 <p>A description of each parameter follows:</p></ol>
2725 <ol><p>the image list.</p></ol>
2728 <ol><p>the image.</p></ol>
2731 <ol><p>the position within the list.</p></ol>
2734 <ol><p>return any errors or warnings in this structure.</p></ol>
2737 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2738 _8c.html" target="source" name="SetImagePixels">SetImagePixels</a></h2>
2739 <div class="doc-section">
2741 <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>
2743 <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>
2745 <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>
2747 <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>
2749 <p>Deprecated, replace with:</p>
2752 QueueAuthenticPixels(image,x,y,columns,rows,&image->exception);
2755 <p>The format of the SetImagePixels() method is:</p>
2758 PixelPacket *SetImagePixels(Image *image,const ssize_t x,const ssize_t y,
2759 const size_t columns,const size_t rows)
2762 <p>A description of each parameter follows:</p></ol>
2765 <ol><p>SetImagePixels returns a pointer to the pixels if they are transferred, otherwise a NULL is returned.</p></ol>
2768 <ol><p>the image.</p></ol>
2770 <h5>x,y,columns,rows</h5>
2771 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
2774 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2775 _8c.html" target="source" name="SetMagickRegistry">SetMagickRegistry</a></h2>
2776 <div class="doc-section">
2778 <p>SetMagickRegistry() sets a blob into the registry and returns a unique ID. If an error occurs, -1 is returned.</p></ol>
2780 <p>The format of the SetMagickRegistry method is:</p>
2783 ssize_t SetMagickRegistry(const RegistryType type,const void *blob,
2784 const size_t length,ExceptionInfo *exception)
2787 <p>A description of each parameter follows:</p></ol>
2790 <ol><p>the registry type.</p></ol>
2793 <ol><p>the address of a Binary Large OBject.</p></ol>
2796 <ol><p>For a registry type of ImageRegistryType use sizeof(Image) otherise the blob length in number of bytes.</p></ol>
2799 <ol><p>return any errors or warnings in this structure.</p></ol>
2802 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2803 _8c.html" target="source" name="SetMonitorHandler">SetMonitorHandler</a></h2>
2804 <div class="doc-section">
2806 <p>SetMonitorHandler() sets the monitor handler to the specified method and returns the previous monitor handler.</p></ol>
2808 <p>The format of the SetMonitorHandler method is:</p>
2811 MonitorHandler SetMonitorHandler(MonitorHandler handler)
2814 <p>A description of each parameter follows:</p></ol>
2817 <ol><p>Specifies a pointer to a method to handle monitors.</p></ol>
2820 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2821 _8c.html" target="source" name="ShiftImageList">ShiftImageList</a></h2>
2822 <div class="doc-section">
2824 <p>ShiftImageList() removes an image from the beginning of the list.</p></ol>
2826 <p>Deprecated, replace with:</p>
2829 RemoveFirstImageFromList(images);
2832 <p>The format of the ShiftImageList method is:</p>
2835 Image *ShiftImageList(Image **images)
2838 <p>A description of each parameter follows:</p></ol>
2841 <ol><p>the image list.</p></ol>
2844 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2845 _8c.html" target="source" name="SpliceImageList">SpliceImageList</a></h2>
2846 <div class="doc-section">
2848 <p>SpliceImageList() removes the images designated by offset and length from the list and replaces them with the specified list.</p></ol>
2850 <p>The format of the SpliceImageList method is:</p>
2853 Image *SpliceImageList(Image *images,const ssize_t offset,
2854 const size_t length,const Image *splices,
2855 ExceptionInfo *exception)
2858 <p>A description of each parameter follows:</p></ol>
2861 <ol><p>the image list.</p></ol>
2864 <ol><p>the position within the list.</p></ol>
2867 <ol><p>the length of the image list to remove.</p></ol>
2870 <ol><p>Replace the removed image list with this list.</p></ol>
2873 <ol><p>return any errors or warnings in this structure.</p></ol>
2876 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2877 _8c.html" target="source" name="Strip">Strip</a></h2>
2878 <div class="doc-section">
2880 <p>Strip() strips any whitespace or quotes from the beginning and end of a string of characters.</p></ol>
2882 <p>The format of the Strip method is:</p>
2885 void Strip(char *message)
2888 <p>A description of each parameter follows:</p></ol>
2891 <ol><p>Specifies an array of characters.</p></ol>
2894 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2895 _8c.html" target="source" name="SyncCacheView">SyncCacheView</a></h2>
2896 <div class="doc-section">
2898 <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>
2900 <p>Deprecated, replace with:</p>
2903 SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
2906 <p>The format of the SyncCacheView method is:</p>
2909 MagickBooleanType SyncCacheView(CacheView *cache_view)
2912 <p>A description of each parameter follows:</p></ol>
2915 <ol><p>the cache view.</p></ol>
2918 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2919 _8c.html" target="source" name="SyncCacheViewPixels">SyncCacheViewPixels</a></h2>
2920 <div class="doc-section">
2922 <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>
2924 <p>Deprecated, replace with:</p>
2927 SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
2930 <p>The format of the SyncCacheViewPixels method is:</p>
2933 MagickBooleanType SyncCacheViewPixels(CacheView *cache_view)
2936 <p>A description of each parameter follows:</p></ol>
2939 <ol><p>the cache view.</p></ol>
2942 <ol><p>return any errors or warnings in this structure.</p></ol>
2945 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2946 _8c.html" target="source" name="SyncImagePixels">SyncImagePixels</a></h2>
2947 <div class="doc-section">
2949 <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>
2951 <p>Deprecated, replace with:</p>
2954 SyncAuthenticPixels(image,&image->exception);
2957 <p>The format of the SyncImagePixels() method is:</p>
2960 MagickBooleanType SyncImagePixels(Image *image)
2963 <p>A description of each parameter follows:</p></ol>
2966 <ol><p>the image.</p></ol>
2969 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2970 _8c.html" target="source" name="TemporaryFilename">TemporaryFilename</a></h2>
2971 <div class="doc-section">
2973 <p>TemporaryFilename() replaces the contents of path by a unique path name.</p></ol>
2975 <p>The format of the TemporaryFilename method is:</p>
2978 void TemporaryFilename(char *path)
2981 <p>A description of each parameter follows.</p></ol>
2984 <ol><p>Specifies a pointer to an array of characters. The unique path name is returned in this array.</p></ol>
2987 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
2988 _8c.html" target="source" name="ThresholdImage">ThresholdImage</a></h2>
2989 <div class="doc-section">
2991 <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>
2993 <p>The format of the ThresholdImage method is:</p>
2996 unsigned int ThresholdImage(Image *image,const double threshold)
2999 <p>A description of each parameter follows:</p></ol>
3002 <ol><p>the image.</p></ol>
3005 <ol><p>Define the threshold value</p></ol>
3008 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3009 _8c.html" target="source" name="ThresholdImageChannel">ThresholdImageChannel</a></h2>
3010 <div class="doc-section">
3012 <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>
3014 <p>The format of the ThresholdImageChannel method is:</p>
3017 unsigned int ThresholdImageChannel(Image *image,const char *threshold)
3020 <p>A description of each parameter follows:</p></ol>
3023 <ol><p>the image.</p></ol>
3026 <ol><p>define the threshold values.</p></ol>
3029 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3030 _8c.html" target="source" name="TransformHSL">TransformHSL</a></h2>
3031 <div class="doc-section">
3033 <p>TransformHSL() converts a (red, green, blue) to a (hue, saturation, lightness) triple.</p></ol>
3035 <p>The format of the TransformHSL method is:</p>
3038 void TransformHSL(const Quantum red,const Quantum green,
3039 const Quantum blue,double *hue,double *saturation,double *lightness)
3042 <p>A description of each parameter follows:</p></ol>
3044 <h5>red, green, blue</h5>
3045 <ol><p>A Quantum value representing the red, green, and blue component of a pixel..</p></ol>
3047 <h5>hue, saturation, lightness</h5>
3048 <ol><p>A pointer to a double value representing a component of the HSL color space.</p></ol>
3051 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3052 _8c.html" target="source" name="TranslateText">TranslateText</a></h2>
3053 <div class="doc-section">
3055 <p>TranslateText() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
3057 <p>Deprecated, replace with:</p>
3060 InterpretImageProperties(image_info,image,embed_text);
3063 <p>The format of the TranslateText method is:</p>
3066 char *TranslateText(const ImageInfo *image_info,Image *image,
3067 const char *embed_text)
3070 <p>A description of each parameter follows:</p></ol>
3073 <ol><p>the image info.</p></ol>
3076 <ol><p>the image.</p></ol>
3079 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
3082 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3083 _8c.html" target="source" name="TransparentImage">TransparentImage</a></h2>
3084 <div class="doc-section">
3086 <p>TransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
3088 <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>
3090 <p>The format of the TransparentImage method is:</p>
3093 MagickBooleanType TransparentImage(Image *image,
3094 const PixelPacket target,const Quantum opacity)
3097 <p>A description of each parameter follows:</p></ol>
3100 <ol><p>the image.</p></ol>
3103 <ol><p>the RGB value of the target color.</p></ol>
3106 <ol><p>the replacement opacity value.</p></ol>
3109 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
3110 _8c.html" target="source" name="UnshiftImageList">UnshiftImageList</a></h2>
3111 <div class="doc-section">
3113 <p>UnshiftImageList() adds the image to the beginning of the list.</p></ol>
3115 <p>Deprecated, replace with:</p>
3118 PrependImageToList(images,CloneImageList(image,exception));
3121 <p>The format of the UnshiftImageList method is:</p>
3124 unsigned int UnshiftImageList(Image *images,const Image *image,
3125 ExceptionInfo *exception)
3128 <p>A description of each parameter follows:</p></ol>
3131 <ol><p>the image list.</p></ol>
3134 <ol><p>the image.</p></ol>
3137 <ol><p>return any errors or warnings in this structure.</p></ol>
3143 <div id="linkbar">
\r
3144 <!-- <span id="linkbar-west"> </span> -->
\r
3145 <span id="linkbar-center">
\r
3146 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
3147 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
3149 <span id="linkbar-east"> </span>
\r
3151 <div class="footer">
\r
3152 <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
\r
3153 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
3155 <div style="clear: both; margin: 0; width: 100%; "></div>
\r