]> granicus.if.org Git - imagemagick/blob - www/api/deprecate.html
(no commit message)
[imagemagick] / www / api / deprecate.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
4 <head>\r
5   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>\r
6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
7   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
8   <style type="text/css" media="all">\r
9     @import url("../../www/magick.css");\r
10   </style>\r
11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
12   <title>ImageMagick: MagickCore, C API for ImageMagick: Deprecated Methods</title>
13   <meta http-equiv="Content-Language" content="en-US"/>
14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16   <meta name="Generator" content="PHP"/>
17   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, deprecated, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
18   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
19   <meta name="Rating" content="GENERAL"/>
20   <meta name="Robots" content="INDEX, FOLLOW"/>
21   <meta name="Generator" content="ImageMagick Studio LLC"/>
22   <meta name="Author" content="ImageMagick Studio LLC"/>
23   <meta name="Revisit-after" content="2 DAYS"/>
24   <meta name="Resource-type" content="document"/>
25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
26   <meta name="Distribution" content="Global"/>
27 </head>\r
28 \r
29 <body id="www-imagemagick-org">\r
30 <div class="titlebar">\r
31 <a href="../../index.html">\r
32   <img src="../../images/script.png" alt="[ImageMagick]"\r
33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
34 <a href="http://www.networkredux.com">\r
35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
37 <a href="http://www.imagemagick.org/discourse-server/">\r
38   <img src="../../images/logo.jpg" alt=""\r
39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
40 <a href="../../index.html">\r
41   <img src="../../images/sprite.jpg" alt=""\r
42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
43 </div>\r
44 \r
45 <div class="eastbar">\r
46 \r
47 <div class="menu">
48   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
49 </div>
50 <div class="sep"></div>\r
51 <div class="menu">
52   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
53 </div>
54 <div class="sub">
55     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
56 </div>
57 <div class="sub">
58     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
59 </div>
60 <div class="sub">
61     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
62 </div>
63 <div class="sep"></div>\r
64 <div class="menu">
65   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
66 </div>
67 <div class="sub">
68     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
69 </div>
70 <div class="sub">
71     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
72 </div>
73 <div class="sub">
74     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
75 </div>
76 <div class="menu">
77   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
78 </div>
79 <div class="sub">
80     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
81 </div>
82 <div class="sub">
83     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
84 </div>
85 <div class="sub">
86     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
87 </div>
88 <div class="sub">
89     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
90 </div>
91 <div class="sep"></div>\r
92 <div  class="menu">
93    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
94 </div>
95 <div class="sub">
96     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
97 </div>
98 <div class="sub">
99     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
100  </div>
101 <div class="menu">
102   <a title="Resources" href="../../www/resources.html">Resources</a>
103 </div>
104 <div class="menu">
105   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106 </div>
107 <div class="menu">
108   <a title="Download" href="../../www/download.html">Download</a>
109 </div>
110 <div class="sep"></div>\r
111 <div class="menu">
112   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
113 </div>
114 <div class="sep"></div>\r
115 <div class="menu">
116   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
117 </div>
118 <div  class="sub">
119     <a title="Site Map: Links"href="../../www/links.html">Links</a>
120 </div>
121 <div class="sep"></div>\r
122 <div  class="menu">
123   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
124
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-->
128 </div>
129 <div  class="sponsor">
130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
131 </div>
132 <div  class="sponsor">
133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
134 </div>
135 <div  class="sponsor">
136   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
137 </div>
138 <div  class="sponsor">
139   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
140 </div>
141 <div  class="sponsor">
142    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
143 </div>
144 <div  class="sponsor">
145    <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/" title="Online-Magazin">Online-Magazin</a><!-- 20101101000200 -->
146 </div>
147 </div>
148 </div>
149 \r
150 \r
151 </div>\r
152 \r
153 <div class="main">\r
154 \r
155 <p class="navigation-index">[<a href="#AcquireCacheViewIndexes">AcquireCacheViewIndexes</a> &bull; <a href="#AcquireCacheViewPixels">AcquireCacheViewPixels</a> &bull; <a href="#AcquireImagePixels">AcquireImagePixels</a> &bull; <a href="#AcquireIndexes">AcquireIndexes</a> &bull; <a href="#AcquireMemory">AcquireMemory</a> &bull; <a href="#AcquireOneCacheViewPixel">AcquireOneCacheViewPixel</a> &bull; <a href="#AcquireOneCacheViewVirtualPixel">AcquireOneCacheViewVirtualPixel</a> &bull; <a href="#AcquireOneMagickPixel">AcquireOneMagickPixel</a> &bull; <a href="#AcquireOnePixel">AcquireOnePixel</a> &bull; <a href="#AcquireOneVirtualPixel">AcquireOneVirtualPixel</a> &bull; <a href="#AcquirePixels">AcquirePixels</a> &bull; <a href="#AffinityImage">AffinityImage</a> &bull; <a href="#AffinityImages">AffinityImages</a> &bull; <a href="#AllocateImage">AllocateImage</a> &bull; <a href="#AllocateImageColormap">AllocateImageColormap</a> &bull; <a href="#AllocateNextImage">AllocateNextImage</a> &bull; <a href="#AllocateString">AllocateString</a> &bull; <a href="#AverageImages">AverageImages</a> &bull; <a href="#ChannelThresholdImage">ChannelThresholdImage</a> &bull; <a href="#ClipPathImage">ClipPathImage</a> &bull; <a href="#CloneImageAttributes">CloneImageAttributes</a> &bull; <a href="#CloneMemory">CloneMemory</a> &bull; <a href="#CloseCacheView">CloseCacheView</a> &bull; <a href="#ColorFloodfill">ColorFloodfill</a> &bull; <a href="#DeleteImageAttribute">DeleteImageAttribute</a> &bull; <a href="#DeleteImageList">DeleteImageList</a> &bull; <a href="#DeleteMagickRegistry">DeleteMagickRegistry</a> &bull; <a href="#DescribeImage">DescribeImage</a> &bull; <a href="#DestroyImageAttributes">DestroyImageAttributes</a> &bull; <a href="#DestroyImages">DestroyImages</a> &bull; <a href="#DestroyMagick">DestroyMagick</a> &bull; <a href="#DispatchImage">DispatchImage</a> &bull; <a href="#ExtractSubimageFromImageImage">ExtractSubimageFromImageImage</a> &bull; <a href="#FlattenImages">FlattenImages</a> &bull; <a href="#FormatImageAttribute">FormatImageAttribute</a> &bull; <a href="#FormatString">FormatString</a> &bull; <a href="#GetConfigureBlob">GetConfigureBlob</a> &bull; <a href="#GetCacheView">GetCacheView</a> &bull; <a href="#GetCacheViewIndexes">GetCacheViewIndexes</a> &bull; <a href="#GetCacheViewPixels">GetCacheViewPixels</a> &bull; <a href="#GetImageAttribute">GetImageAttribute</a> &bull; <a href="#GetImageClippingPathAttribute">GetImageClippingPathAttribute</a> &bull; <a href="#GetImageFromMagickRegistry">GetImageFromMagickRegistry</a> &bull; <a href="#GetMagickRegistry">GetMagickRegistry</a> &bull; <a href="#GetImageGeometry">GetImageGeometry</a> &bull; <a href="#GetImageList">GetImageList</a> &bull; <a href="#GetImageListIndex">GetImageListIndex</a> &bull; <a href="#GetImageListSize">GetImageListSize</a> &bull; <a href="#GetImagePixels">GetImagePixels</a> &bull; <a href="#GetIndexes">GetIndexes</a> &bull; <a href="#GetNextImage">GetNextImage</a> &bull; <a href="#GetNextImageAttribute">GetNextImageAttribute</a> &bull; <a href="#GetNumberScenes">GetNumberScenes</a> &bull; <a href="#GetOnePixel">GetOnePixel</a> &bull; <a href="#GetPixels">GetPixels</a> &bull; <a href="#GetPreviousImage">GetPreviousImage</a> &bull; <a href="#HSLTransform">HSLTransform</a> &bull; <a href="#IdentityAffine">IdentityAffine</a> &bull; <a href="#InitializeMagick">InitializeMagick</a> &bull; <a href="#InterpolatePixelColor">InterpolatePixelColor</a> &bull; <a href="#InterpretImageAttributes">InterpretImageAttributes</a> &bull; <a href="#LevelImageColor">LevelImageColor</a> &bull; <a href="#LiberateMemory">LiberateMemory</a> &bull; <a href="#LiberateSemaphoreInfo">LiberateSemaphoreInfo</a> &bull; <a href="#MagickIncarnate">MagickIncarnate</a> &bull; <a href="#MagickMonitor">MagickMonitor</a> &bull; <a href="#MapImage">MapImage</a> &bull; <a href="#MapImages">MapImages</a> &bull; <a href="#MatteFloodfill">MatteFloodfill</a> &bull; <a href="#MaximumImages">MaximumImages</a> &bull; <a href="#MinimumImages">MinimumImages</a> &bull; <a href="#MosaicImages">MosaicImages</a> &bull; <a href="#OpaqueImage">OpaqueImage</a> &bull; <a href="#OpenCacheView">OpenCacheView</a> &bull; <a href="#PaintFloodfill">PaintFloodfill</a> &bull; <a href="#PaintOpaqueImage">PaintOpaqueImage</a> &bull; <a href="#PaintTransparentImage">PaintTransparentImage</a> &bull; <a href="#ParseSizeGeometry">ParseSizeGeometry</a> &bull; <a href="#PopImageList">PopImageList</a> &bull; <a href="#PopImagePixels">PopImagePixels</a> &bull; <a href="#PostscriptGeometry">PostscriptGeometry</a> &bull; <a href="#PushImageList">PushImageList</a> &bull; <a href="#PushImagePixels">PushImagePixels</a> &bull; <a href="#QuantizationError">QuantizationError</a> &bull; <a href="#RandomChannelThresholdImage">RandomChannelThresholdImage</a> &bull; <a href="#ReacquireMemory">ReacquireMemory</a> &bull; <a href="#RecolorImage">RecolorImage</a> &bull; <a href="#ResetImageAttributeIterator">ResetImageAttributeIterator</a> &bull; <a href="#SetCacheViewPixels">SetCacheViewPixels</a> &bull; <a href="#SetExceptionInfo">SetExceptionInfo</a> &bull; <a href="#SetImage">SetImage</a> &bull; <a href="#SetImageAttribute">SetImageAttribute</a> &bull; <a href="#SetImageList">SetImageList</a> &bull; <a href="#SetImagePixels">SetImagePixels</a> &bull; <a href="#SetMagickRegistry">SetMagickRegistry</a> &bull; <a href="#SetMonitorHandler">SetMonitorHandler</a> &bull; <a href="#ShiftImageList">ShiftImageList</a> &bull; <a href="#SpliceImageList">SpliceImageList</a> &bull; <a href="#Strip">Strip</a> &bull; <a href="#SyncCacheView">SyncCacheView</a> &bull; <a href="#SyncCacheViewPixels">SyncCacheViewPixels</a> &bull; <a href="#SyncImagePixels">SyncImagePixels</a> &bull; <a href="#TemporaryFilename">TemporaryFilename</a> &bull; <a href="#ThresholdImage">ThresholdImage</a> &bull; <a href="#ThresholdImageChannel">ThresholdImageChannel</a> &bull; <a href="#TransformHSL">TransformHSL</a> &bull; <a href="#TranslateText">TranslateText</a> &bull; <a href="#TransparentImage">TransparentImage</a> &bull; <a href="#UnshiftImageList">UnshiftImageList</a>]</p>
156
157 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
158 _8c.html" target="source" name="AcquireCacheViewIndexes">AcquireCacheViewIndexes</a></h2>
159 <div class="doc-section">
160
161 <p>AcquireCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
162
163 <p>Deprecated, replace with:</p>
164
165 <pre class="text">
166       GetCacheViewVirtualIndexQueue(cache_view);
167 </pre>
168
169 <p>The format of the AcquireCacheViewIndexes method is:</p>
170
171 <pre class="code">
172   const IndexPacket *AcquireCacheViewIndexes(const CacheView *cache_view)
173 </pre>
174
175 <p>A description of each parameter follows:</p></ol>
176
177 <h5>cache_view</h5>
178 <ol><p>the cache view.</p></ol>
179
180  </div>
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">
184
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>
186
187 <p>Deprecated, replace with:</p>
188
189 <pre class="text">
190       GetCacheViewVirtualPixels(cache_view,x,y,columns,rows,exception);
191 </pre>
192
193 <p>The format of the AcquireCacheViewPixels method is:</p>
194
195 <pre class="code">
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)
199 </pre>
200
201 <p>A description of each parameter follows:</p></ol>
202
203 <h5>cache_view</h5>
204 <ol><p>the cache view.</p></ol>
205
206 <h5>x,y,columns,rows</h5>
207 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
208
209 <h5>exception</h5>
210 <ol><p>return any errors or warnings in this structure.</p></ol>
211
212  </div>
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">
216
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>
218
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>
220
221 <p>If you plan to modify the pixels, use GetAuthenticPixels() instead.</p></ol>
222
223 <p>Note, the AcquireImagePixels() and GetAuthenticPixels() methods are not thread-safe.  In a threaded environment, use GetCacheViewVirtualPixels() or GetCacheViewAuthenticPixels() instead.</p></ol>
224
225 <p>Deprecated, replace with:</p>
226
227 <pre class="text">
228       GetVirtualPixels(image,x,y,columns,rows,exception);
229 </pre>
230
231 <p>The format of the AcquireImagePixels() method is:</p>
232
233 <pre class="code">
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)
237 </pre>
238
239 <p>A description of each parameter follows:</p></ol>
240
241 <h5>image</h5>
242 <ol><p>the image.</p></ol>
243
244 <h5>x,y,columns,rows</h5>
245 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
246
247 <h5>exception</h5>
248 <ol><p>return any errors or warnings in this structure.</p></ol>
249
250  </div>
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">
254
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>
256
257 <p>Deprecated, replace with:</p>
258
259 <pre class="text">
260       GetVirtualIndexQueue(image);
261 </pre>
262
263 <p>The format of the AcquireIndexes() method is:</p>
264
265 <pre class="code">
266   const IndexPacket *AcquireIndexes(const Image *image)
267 </pre>
268
269 <p>A description of each parameter follows:</p></ol>
270
271 <h5>indexes</h5>
272 <ol><p>AcquireIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
273
274 <h5>image</h5>
275 <ol><p>the image.</p></ol>
276
277  </div>
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">
281
282 <p>AcquireMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.</p></ol>
283
284 <p>The format of the AcquireMemory method is:</p>
285
286 <pre class="code">
287   void *AcquireMemory(const size_t size)
288 </pre>
289
290 <p>A description of each parameter follows:</p></ol>
291
292 <h5>size</h5>
293 <ol><p>the size of the memory in bytes to allocate.</p></ol>
294
295  </div>
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">
299
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>
301
302 <p>Deprecated, replace with:</p>
303
304 <pre class="text">
305       GetOneCacheViewVirtualPixel(cache_view,x,y,pixel,exception);
306 </pre>
307
308 <p>The format of the AcquireOneCacheViewPixel method is:</p>
309
310 <pre class="code">
311   MagickBooleanType AcquireOneCacheViewPixel(const CacheView *cache_view,
312     const ssize_t x,const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
313 </pre>
314
315 <p>A description of each parameter follows:</p></ol>
316
317 <h5>cache_view</h5>
318 <ol><p>the cache view.</p></ol>
319
320 <h5>x,y</h5>
321 <ol><p>These values define the offset of the pixel.</p></ol>
322
323 <h5>pixel</h5>
324 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
325
326 <h5>exception</h5>
327 <ol><p>return any errors or warnings in this structure.</p></ol>
328
329  </div>
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">
333
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>
335
336 <p>Deprecated, replace with:</p>
337
338 <pre class="text">
339       GetOneCacheViewVirtualMethodPixel(cache_view,virtual_pixel_method,
340   x,y,pixel,exception);
341 </pre>
342
343 <p>The format of the AcquireOneCacheViewPixel method is:</p>
344
345 <pre class="code">
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)
350 </pre>
351
352 <p>A description of each parameter follows:</p></ol>
353
354 <h5>cache_view</h5>
355 <ol><p>the cache view.</p></ol>
356
357 <h5>virtual_pixel_method</h5>
358 <ol><p>the virtual pixel method.</p></ol>
359
360 <h5>x,y</h5>
361 <ol><p>These values define the offset of the pixel.</p></ol>
362
363 <h5>pixel</h5>
364 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
365
366 <h5>exception</h5>
367 <ol><p>return any errors or warnings in this structure.</p></ol>
368
369  </div>
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">
373
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>
375
376 <p>Deprecated, replace with:</p>
377
378 <pre class="text">
379       MagickPixelPacket pixel;
380       GetOneVirtualMagickPixel(image,x,y,&pixel,exception);
381 </pre>
382
383 <p>The format of the AcquireOneMagickPixel() method is:</p>
384
385 <pre class="code">
386   MagickPixelPacket AcquireOneMagickPixel(const Image image,const ssize_t x,
387     const ssize_t y,ExceptionInfo exception)
388 </pre>
389
390 <p>A description of each parameter follows:</p></ol>
391
392 <h5>image</h5>
393 <ol><p>the image.</p></ol>
394
395 <h5>x,y</h5>
396 <ol><p>These values define the location of the pixel to return.</p></ol>
397
398 <h5>exception</h5>
399 <ol><p>return any errors or warnings in this structure.</p></ol>
400
401  </div>
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">
405
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>
407
408 <p>Deprecated, replace with:</p>
409
410 <pre class="text">
411       PixelPacket pixel;
412       GetOneVirtualPixel(image,x,y,&pixel,exception);
413 </pre>
414
415 <p>The format of the AcquireOnePixel() method is:</p>
416
417 <pre class="code">
418   PixelPacket AcquireOnePixel(const Image image,const ssize_t x,
419     const ssize_t y,ExceptionInfo exception)
420 </pre>
421
422 <p>A description of each parameter follows:</p></ol>
423
424 <h5>image</h5>
425 <ol><p>the image.</p></ol>
426
427 <h5>x,y</h5>
428 <ol><p>These values define the location of the pixel to return.</p></ol>
429
430 <h5>exception</h5>
431 <ol><p>return any errors or warnings in this structure.</p></ol>
432
433  </div>
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">
437
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>
439
440 <p>Deprecated, replace with:</p>
441
442 <pre class="text">
443       PixelPacket pixel;
444       GetOneVirtualMethodPixel(image,virtual_pixel_method,x,y,&pixel,exception);
445 </pre>
446
447 <p>The format of the AcquireOneVirtualPixel() method is:</p>
448
449 <pre class="code">
450   PixelPacket AcquireOneVirtualPixel(const Image image,
451     const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
452     const ssize_t y,ExceptionInfo exception)
453 </pre>
454
455 <p>A description of each parameter follows:</p></ol>
456
457 <h5>virtual_pixel_method</h5>
458 <ol><p>the virtual pixel method.</p></ol>
459
460 <h5>image</h5>
461 <ol><p>the image.</p></ol>
462
463 <h5>x,y</h5>
464 <ol><p>These values define the location of the pixel to return.</p></ol>
465
466 <h5>exception</h5>
467 <ol><p>return any errors or warnings in this structure.</p></ol>
468
469  </div>
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">
473
474 <p>AcquirePixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
475
476 <p>Deprecated, replace with:</p>
477
478 <pre class="text">
479       GetVirtualPixelQueue(image);
480 </pre>
481
482 <p>The format of the AcquirePixels() method is:</p>
483
484 <pre class="code">
485   const PixelPacket *AcquirePixels(const Image image)
486 </pre>
487
488 <p>A description of each parameter follows:</p></ol>
489
490 <h5>image</h5>
491 <ol><p>the image.</p></ol>
492
493  </div>
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">
497
498 <p>AffinityImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
499
500 <p>Deprecated, replace with:</p>
501
502 <pre class="text">
503       RemapImage(quantize_info,image,affinity_image);
504 </pre>
505
506 <p>The format of the AffinityImage method is:</p>
507
508 <pre class="code">
509   MagickBooleanType AffinityImage(const QuantizeInfo *quantize_info,
510     Image *image,const Image *affinity_image)
511 </pre>
512
513 <p>A description of each parameter follows:</p></ol>
514
515 <h5>quantize_info</h5>
516 <ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
517
518 <h5>image</h5>
519 <ol><p>the image.</p></ol>
520
521 <h5>affinity_image</h5>
522 <ol><p>the reference image.</p></ol>
523
524  </div>
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">
528
529 <p>AffinityImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
530
531 <p>Deprecated, replace with:</p>
532
533 <pre class="text">
534       RemapImages(quantize_info,images,affinity_image);
535 </pre>
536
537 <p>The format of the AffinityImage method is:</p>
538
539 <pre class="code">
540   MagickBooleanType AffinityImages(const QuantizeInfo *quantize_info,
541     Image *images,Image *affinity_image)
542 </pre>
543
544 <p>A description of each parameter follows:</p></ol>
545
546 <h5>quantize_info</h5>
547 <ol><p>Specifies a pointer to an QuantizeInfo structure.</p></ol>
548
549 <h5>images</h5>
550 <ol><p>the image sequence.</p></ol>
551
552 <h5>affinity_image</h5>
553 <ol><p>the reference image.</p></ol>
554
555  </div>
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">
559
560 <p>AllocateImage() returns a pointer to an image structure initialized to default values.</p></ol>
561
562 <p>Deprecated, replace with:</p>
563
564 <pre class="text">
565       AcquireImage(image_info);
566 </pre>
567
568 <p>The format of the AllocateImage method is:</p>
569
570 <pre class="code">
571   Image *AllocateImage(const ImageInfo *image_info)
572 </pre>
573
574 <p>A description of each parameter follows:</p></ol>
575
576 <h5>image_info</h5>
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>
578
579  </div>
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">
583
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>
585
586 <p>Deprecated, replace with:</p>
587
588 <pre class="text">
589       AcquireImageColormap(image,colors);
590 </pre>
591
592 <p>The format of the AllocateImageColormap method is:</p>
593
594 <pre class="code">
595   MagickBooleanType AllocateImageColormap(Image *image,
596     const size_t colors)
597 </pre>
598
599 <p>A description of each parameter follows:</p></ol>
600
601 <h5>image</h5>
602 <ol><p>the image.</p></ol>
603
604 <h5>colors</h5>
605 <ol><p>the number of colors in the image colormap.</p></ol>
606
607  </div>
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">
611
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>
613
614 <p>Deprecated, replace with:</p>
615
616 <pre class="text">
617       AcquireNextImage(image_info,image);
618 </pre>
619
620 <p>The format of the AllocateNextImage method is:</p>
621
622 <pre class="code">
623   void AllocateNextImage(const ImageInfo *image_info,Image *image)
624 </pre>
625
626 <p>A description of each parameter follows:</p></ol>
627
628 <h5>image_info</h5>
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>
630
631 <h5>image</h5>
632 <ol><p>the image.</p></ol>
633
634  </div>
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">
638
639 <p>AllocateString() allocates memory for a string and copies the source string to that memory location (and returns it).</p></ol>
640
641 <p>The format of the AllocateString method is:</p>
642
643 <pre class="code">
644   char *AllocateString(const char *source)
645 </pre>
646
647 <p>A description of each parameter follows:</p></ol>
648
649 <h5>source</h5>
650 <ol><p>A character string.</p></ol>
651
652  </div>
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">
656
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>
658
659 <p>Deprecated, replace with:</p>
660
661 <pre class="text">
662       EvaluateImages(images,MeanEvaluateOperator,exception);
663 </pre>
664
665 <p>The format of the AverageImages method is:</p>
666
667 <pre class="code">
668   Image *AverageImages(Image *images,ExceptionInfo *exception)
669 </pre>
670
671 <p>A description of each parameter follows:</p></ol>
672
673 <h5>image</h5>
674 <ol><p>the image sequence.</p></ol>
675
676 <h5>exception</h5>
677 <ol><p>return any errors or warnings in this structure.</p></ol>
678
679  </div>
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">
683
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>
685
686 <p>The format of the ChannelThresholdImage method is:</p>
687
688 <pre class="code">
689   unsigned int ChannelThresholdImage(Image *image,const char *level)
690 </pre>
691
692 <p>A description of each parameter follows:</p></ol>
693
694 <h5>image</h5>
695 <ol><p>the image.</p></ol>
696
697 <h5>level</h5>
698 <ol><p>define the threshold values.</p></ol>
699
700  </div>
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">
704
705 <p>ClipPathImage() sets the image clip mask based any clipping path information if it exists.</p></ol>
706
707 <p>Deprecated, replace with:</p>
708
709 <pre class="text">
710       ClipImagePath(image,pathname,inside);
711 </pre>
712
713 <p>The format of the ClipImage method is:</p>
714
715 <pre class="code">
716   MagickBooleanType ClipPathImage(Image *image,const char *pathname,
717     const MagickBooleanType inside)
718 </pre>
719
720 <p>A description of each parameter follows:</p></ol>
721
722 <h5>image</h5>
723 <ol><p>the image.</p></ol>
724
725 <h5>pathname</h5>
726 <ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
727
728 <h5>inside</h5>
729 <ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
730
731  </div>
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">
735
736 <p>CloneImageAttributes() clones one or more image attributes.</p></ol>
737
738 <p>Deprecated, replace with:</p>
739
740 <pre class="text">
741       CloneImageProperties(image,clone_image);
742 </pre>
743
744 <p>The format of the CloneImageAttributes method is:</p>
745
746 <pre class="code">
747   MagickBooleanType CloneImageAttributes(Image *image,
748     const Image *clone_image)
749 </pre>
750
751 <p>A description of each parameter follows:</p></ol>
752
753 <h5>image</h5>
754 <ol><p>the image.</p></ol>
755
756 <h5>clone_image</h5>
757 <ol><p>the clone image.</p></ol>
758
759  </div>
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">
763
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>
765
766 <p>The format of the CloneMemory method is:</p>
767
768 <pre class="code">
769   void *CloneMemory(void *destination,const void *source,
770     const size_t size)
771 </pre>
772
773 <p>A description of each parameter follows:</p></ol>
774
775 <h5>destination</h5>
776 <ol><p>the destination.</p></ol>
777
778 <h5>source</h5>
779 <ol><p>the source.</p></ol>
780
781 <h5>size</h5>
782 <ol><p>the size of the memory in bytes to allocate.</p></ol>
783
784  </div>
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">
788
789 <p>CloseCacheView() closes the specified view returned by a previous call to OpenCacheView().</p></ol>
790
791 <p>Deprecated, replace with:</p>
792
793 <pre class="text">
794       DestroyCacheView(view_info);
795 </pre>
796
797 <p>The format of the CloseCacheView method is:</p>
798
799 <pre class="code">
800   CacheView *CloseCacheView(CacheView *view_info)
801 </pre>
802
803 <p>A description of each parameter follows:</p></ol>
804
805 <h5>view_info</h5>
806 <ol><p>the address of a structure of type CacheView.</p></ol>
807
808  </div>
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">
812
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>
814
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>
816
817 <p>The format of the ColorFloodfillImage method is:</p>
818
819 <pre class="code">
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)
823 </pre>
824
825 <p>A description of each parameter follows:</p></ol>
826
827 <h5>image</h5>
828 <ol><p>the image.</p></ol>
829
830 <h5>draw_info</h5>
831 <ol><p>the draw info.</p></ol>
832
833 <h5>target</h5>
834 <ol><p>the RGB value of the target color.</p></ol>
835
836 <h5>x,y</h5>
837 <ol><p>the starting location of the operation.</p></ol>
838
839 <h5>method</h5>
840 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
841
842  </div>
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">
846
847 <p>DeleteImageAttribute() deletes an attribute from the image.</p></ol>
848
849 <p>Deprecated, replace with:</p>
850
851 <pre class="text">
852       DeleteImageProperty(image,key);
853 </pre>
854
855 <p>The format of the DeleteImageAttribute method is:</p>
856
857 <pre class="code">
858   MagickBooleanType DeleteImageAttribute(Image *image,const char *key)
859 </pre>
860
861 <p>A description of each parameter follows:</p></ol>
862
863 <h5>image</h5>
864 <ol><p>the image info.</p></ol>
865
866 <h5>key</h5>
867 <ol><p>the image key.</p></ol>
868
869  </div>
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">
873
874 <p>DeleteImageList() deletes an image at the specified position in the list.</p></ol>
875
876 <p>The format of the DeleteImageList method is:</p>
877
878 <pre class="code">
879   unsigned int DeleteImageList(Image *images,const ssize_t offset)
880 </pre>
881
882 <p>A description of each parameter follows:</p></ol>
883
884 <h5>images</h5>
885 <ol><p>the image list.</p></ol>
886
887 <h5>offset</h5>
888 <ol><p>the position within the list.</p></ol>
889
890  </div>
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">
894
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>
896
897 <p>Deprecated, replace with:</p>
898
899 <pre class="text">
900       char key[MaxTextExtent];
901       FormatMagickString(key,MaxTextExtent,"ld\n",id);
902       DeleteImageRegistry(key);
903 </pre>
904
905 <p>The format of the DeleteMagickRegistry method is:</p>
906
907 <pre class="code">
908   MagickBooleanType DeleteMagickRegistry(const ssize_t id)
909 </pre>
910
911 <p>A description of each parameter follows:</p></ol>
912
913 <h5>id</h5>
914 <ol><p>the registry id.</p></ol>
915
916  </div>
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">
920
921 <p>DescribeImage() describes an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p></ol>
922
923 <p>Deprecated, replace with:</p>
924
925 <pre class="text">
926       IdentifyImage(image,file,verbose);
927 </pre>
928
929 <p>The format of the DescribeImage method is:</p>
930
931 <pre class="code">
932   MagickBooleanType DescribeImage(Image *image,FILE *file,
933     const MagickBooleanType verbose)
934 </pre>
935
936 <p>A description of each parameter follows:</p></ol>
937
938 <h5>image</h5>
939 <ol><p>the image.</p></ol>
940
941 <h5>file</h5>
942 <ol><p>the file, typically stdout.</p></ol>
943
944 <h5>verbose</h5>
945 <ol><p>A value other than zero prints more detailed information about the image.</p></ol>
946
947  </div>
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">
951
952 <p>DestroyImageAttributes() deallocates memory associated with the image attribute list.</p></ol>
953
954 <p>The format of the DestroyImageAttributes method is:</p>
955
956 <pre class="code">
957   DestroyImageAttributes(Image *image)
958 </pre>
959
960 <p>A description of each parameter follows:</p></ol>
961
962 <h5>image</h5>
963 <ol><p>the image.</p></ol>
964
965  </div>
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">
969
970 <p>DestroyImages() destroys an image list.</p></ol>
971
972 <p>Deprecated, replace with:</p>
973
974 <pre class="text">
975       DestroyImageList(image);
976 </pre>
977
978 <p>The format of the DestroyImages method is:</p>
979
980 <pre class="code">
981   void DestroyImages(Image *image)
982 </pre>
983
984 <p>A description of each parameter follows:</p></ol>
985
986 <h5>image</h5>
987 <ol><p>the image sequence.</p></ol>
988
989  </div>
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">
993
994 <p>DestroyMagick() destroys the ImageMagick environment.</p></ol>
995
996 <p>Deprecated, replace with:</p>
997
998 <pre class="text">
999       MagickCoreTerminus();
1000 </pre>
1001
1002 <p>The format of the DestroyMagick function is:</p>
1003
1004 <pre class="text">
1005   DestroyMagick(void)
1006 </pre>
1007
1008  </div>
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">
1012
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>
1014
1015 <p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
1016
1017 <pre class="text">
1018   DispatchImage(image,0,0,640,1,"RGB",CharPixel,pixels,exception);
1019 </pre>
1020
1021 <p>Deprecated, replace with:</p>
1022
1023 <pre class="text">
1024       ExportImagePixels(image,x_offset,y_offset,columns,rows,map,type,pixels,
1025   exception);
1026 </pre>
1027
1028 <p>The format of the DispatchImage method is:</p>
1029
1030 <pre class="code">
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)
1035 </pre>
1036
1037 <p>A description of each parameter follows:</p></ol>
1038
1039 <h5>image</h5>
1040 <ol><p>the image.</p></ol>
1041
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>
1044
1045 <h5>map</h5>
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>
1047
1048 <h5>type</h5>
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>
1050
1051 <h5>pixels</h5>
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>
1053
1054 <h5>exception</h5>
1055 <ol><p>return any errors or warnings in this structure.</p></ol>
1056
1057  </div>
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">
1061
1062 <p>ExtractSubimageFromImageImage() extracts a region of the image that most closely resembles the reference.</p></ol>
1063
1064 <p>The format of the ExtractSubimageFromImageImage method is:</p>
1065
1066 <pre class="code">
1067   Image *ExtractSubimageFromImage(const Image *image,
1068     const Image *reference,ExceptionInfo *exception)
1069 </pre>
1070
1071 <p>A description of each parameter follows:</p></ol>
1072
1073 <h5>image</h5>
1074 <ol><p>the image.</p></ol>
1075
1076 <h5>reference</h5>
1077 <ol><p>find an area of the image that closely resembles this image.</p></ol>
1078
1079 <h5>exception</h5>
1080 <ol><p>return any errors or warnings in this structure.</p></ol>
1081
1082  </div>
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">
1086
1087 <p>FlattenImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
1088
1089 <p>Deprecated, replace with:</p>
1090
1091 <pre class="text">
1092       MergeImageLayers(image,FlattenLayer,exception);
1093 </pre>
1094
1095 <p>The format of the FlattenImage method is:</p>
1096
1097 <pre class="code">
1098   Image *FlattenImage(Image *image,ExceptionInfo *exception)
1099 </pre>
1100
1101 <p>A description of each parameter follows:</p></ol>
1102
1103 <h5>image</h5>
1104 <ol><p>the image sequence.</p></ol>
1105
1106 <h5>exception</h5>
1107 <ol><p>return any errors or warnings in this structure.</p></ol>
1108
1109  </div>
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">
1113
1114 <p>FormatImageAttribute() permits formatted key/value pairs to be saved as an image attribute.</p></ol>
1115
1116 <p>The format of the FormatImageAttribute method is:</p>
1117
1118 <pre class="code">
1119   MagickBooleanType FormatImageAttribute(Image *image,const char *key,
1120     const char *format,...)
1121 </pre>
1122
1123 <p>A description of each parameter follows.</p></ol>
1124
1125 <h5> image</h5>
1126 <ol><p>The image.</p></ol>
1127
1128 <h5> key</h5>
1129 <ol><p>The attribute key.</p></ol>
1130
1131 <h5> format</h5>
1132 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
1133
1134  </div>
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">
1138
1139 <p>FormatString() prints formatted output of a variable argument list.</p></ol>
1140
1141 <p>The format of the FormatString method is:</p>
1142
1143 <pre class="code">
1144   void FormatString(char *string,const char *format,...)
1145 </pre>
1146
1147 <p>A description of each parameter follows.</p></ol>
1148
1149 <h5> string</h5>
1150 <ol><p>Method FormatString returns the formatted string in this character buffer.</p></ol>
1151
1152 <h5> format</h5>
1153 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
1154
1155  </div>
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">
1159
1160 <p>GetConfigureBlob() returns the specified configure file as a blob.</p></ol>
1161
1162 <p>The format of the GetConfigureBlob method is:</p>
1163
1164 <pre class="code">
1165   void *GetConfigureBlob(const char *filename,ExceptionInfo *exception)
1166 </pre>
1167
1168 <p>A description of each parameter follows:</p></ol>
1169
1170 <h5>filename</h5>
1171 <ol><p>the configure file name.</p></ol>
1172
1173 <h5>path</h5>
1174 <ol><p>return the full path information of the configure file.</p></ol>
1175
1176 <h5>length</h5>
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>
1178
1179 <h5>exception</h5>
1180 <ol><p>return any errors or warnings in this structure.</p></ol>
1181
1182  </div>
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">
1186
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>
1188
1189 <p>Deprecated, replace with:</p>
1190
1191 <pre class="text">
1192       GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
1193   GetCacheViewException(cache_view));
1194 </pre>
1195
1196 <p>The format of the GetCacheView method is:</p>
1197
1198 <pre class="code">
1199   PixelPacket *GetCacheView(CacheView *cache_view,const ssize_t x,
1200     const ssize_t y,const size_t columns,const size_t rows)
1201 </pre>
1202
1203 <p>A description of each parameter follows:</p></ol>
1204
1205 <h5>cache_view</h5>
1206 <ol><p>the address of a structure of type CacheView.</p></ol>
1207
1208 <h5>x,y,columns,rows</h5>
1209 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1210
1211  </div>
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">
1215
1216 <p>GetCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
1217
1218 <p>Deprecated, replace with:</p>
1219
1220 <pre class="text">
1221       GetCacheViewAuthenticIndexQueue(cache_view);
1222 </pre>
1223
1224 <p>The format of the GetCacheViewIndexes method is:</p>
1225
1226 <pre class="code">
1227   IndexPacket *GetCacheViewIndexes(CacheView *cache_view)
1228 </pre>
1229
1230 <p>A description of each parameter follows:</p></ol>
1231
1232 <h5>cache_view</h5>
1233 <ol><p>the cache view.</p></ol>
1234
1235  </div>
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">
1239
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>
1241
1242 <p>Deprecated, replace with:</p>
1243
1244 <pre class="text">
1245       GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
1246   GetCacheViewException(cache_view));
1247 </pre>
1248
1249 <p>The format of the GetCacheViewPixels method is:</p>
1250
1251 <pre class="code">
1252   PixelPacket *GetCacheViewPixels(CacheView *cache_view,const ssize_t x,
1253     const ssize_t y,const size_t columns,const size_t rows)
1254 </pre>
1255
1256 <p>A description of each parameter follows:</p></ol>
1257
1258 <h5>cache_view</h5>
1259 <ol><p>the cache view.</p></ol>
1260
1261 <h5>x,y,columns,rows</h5>
1262 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1263
1264  </div>
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">
1268
1269 <p>GetImageAttribute() searches the list of image attributes and returns a pointer to the attribute if it exists otherwise NULL.</p></ol>
1270
1271 <p>The format of the GetImageAttribute method is:</p>
1272
1273 <pre class="code">
1274   const ImageAttribute *GetImageAttribute(const Image *image,
1275     const char *key)
1276 </pre>
1277
1278 <p>A description of each parameter follows:</p></ol>
1279
1280 <h5>image</h5>
1281 <ol><p>the image.</p></ol>
1282
1283 <h5>key</h5>
1284 <ol><p>These character strings are the name of an image attribute to return.</p></ol>
1285
1286  </div>
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">
1290
1291 <p>GetImageClippingPathAttribute() searches the list of image attributes and returns a pointer to a clipping path if it exists otherwise NULL.</p></ol>
1292
1293 <p>Deprecated, replace with:</p>
1294
1295 <pre class="text">
1296       GetImageAttribute(image,"8BIM:1999,2998");
1297 </pre>
1298
1299 <p>The format of the GetImageClippingPathAttribute method is:</p>
1300
1301 <pre class="code">
1302   const ImageAttribute *GetImageClippingPathAttribute(Image *image)
1303 </pre>
1304
1305 <p>A description of each parameter follows:</p></ol>
1306
1307 <h5>attribute</h5>
1308 <ol><p>Method GetImageClippingPathAttribute returns the clipping path if it exists otherwise NULL.</p></ol>
1309
1310 <h5>image</h5>
1311 <ol><p>the image.</p></ol>
1312
1313  </div>
1314 <h2><a href="http://www.imagemagick.org/api/MagickCore/deprecate
1315 _8c.html" target="source" name="GetImageFromMagickRegistry">GetImageFromMagickRegistry</a></h2>
1316 <div class="doc-section">
1317
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>
1319
1320 <p>Deprecated, replace with:</p>
1321
1322 <pre class="text">
1323       GetImageRegistry(ImageRegistryType,name,exception);
1324 </pre>
1325
1326 <p>The format of the GetImageFromMagickRegistry method is:</p>
1327
1328 <pre class="code">
1329   Image *GetImageFromMagickRegistry(const char *name,ssize_t *id,
1330     ExceptionInfo *exception)
1331 </pre>
1332
1333 <p>A description of each parameter follows:</p></ol>
1334
1335 <h5>name</h5>
1336 <ol><p>the name of the image to retrieve from the registry.</p></ol>
1337
1338 <h5>id</h5>
1339 <ol><p>the registry id.</p></ol>
1340
1341 <h5>exception</h5>
1342 <ol><p>return any errors or warnings in this structure.</p></ol>
1343
1344  </div>
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">
1348
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>
1350
1351 <p>The format of the GetMagickRegistry method is:</p>
1352
1353 <pre class="code">
1354   const void *GetMagickRegistry(const ssize_t id,RegistryType *type,
1355     size_t *length,ExceptionInfo *exception)
1356 </pre>
1357
1358 <p>A description of each parameter follows:</p></ol>
1359
1360 <h5>id</h5>
1361 <ol><p>the registry id.</p></ol>
1362
1363 <h5>type</h5>
1364 <ol><p>the registry type.</p></ol>
1365
1366 <h5>length</h5>
1367 <ol><p>the blob length in number of bytes.</p></ol>
1368
1369 <h5>exception</h5>
1370 <ol><p>return any errors or warnings in this structure.</p></ol>
1371
1372  </div>
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">
1376
1377 <p>GetImageGeometry() returns a region as defined by the geometry string with respect to the image and its gravity.</p></ol>
1378
1379 <p>Deprecated, replace with:</p>
1380
1381 <pre class="text">
1382       if (size_to_fit != MagickFalse)
1383   ParseRegionGeometry(image,geometry,region_info,&image->exception); else
1384   ParsePageGeometry(image,geometry,region_info,&image->exception);
1385 </pre>
1386
1387 <p>The format of the GetImageGeometry method is:</p>
1388
1389 <pre class="code">
1390   int GetImageGeometry(Image *image,const char *geometry,
1391     const unsigned int size_to_fit,RectangeInfo *region_info)
1392 </pre>
1393
1394 <p>A description of each parameter follows:</p></ol>
1395
1396 <h5>flags</h5>
1397 <ol><p>Method GetImageGeometry returns a bitmask that indicates which of the four values were located in the geometry string.</p></ol>
1398
1399 <h5>geometry</h5>
1400 <ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
1401
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>
1404
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>
1407
1408  </div>
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">
1412
1413 <p>GetImageList() returns an image at the specified position in the list.</p></ol>
1414
1415 <p>Deprecated, replace with:</p>
1416
1417 <pre class="text">
1418       CloneImage(GetImageFromList(images,(ssize_t) offset),0,0,MagickTrue,
1419   exception);
1420 </pre>
1421
1422 <p>The format of the GetImageList method is:</p>
1423
1424 <pre class="code">
1425   Image *GetImageList(const Image *images,const ssize_t offset,
1426     ExceptionInfo *exception)
1427 </pre>
1428
1429 <p>A description of each parameter follows:</p></ol>
1430
1431 <h5>images</h5>
1432 <ol><p>the image list.</p></ol>
1433
1434 <h5>offset</h5>
1435 <ol><p>the position within the list.</p></ol>
1436
1437 <h5>exception</h5>
1438 <ol><p>return any errors or warnings in this structure.</p></ol>
1439
1440  </div>
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">
1444
1445 <p>GetImageListIndex() returns the position in the list of the specified image.</p></ol>
1446
1447 <p>Deprecated, replace with:</p>
1448
1449 <pre class="text">
1450       GetImageIndexInList(images);
1451 </pre>
1452
1453 <p>The format of the GetImageListIndex method is:</p>
1454
1455 <pre class="code">
1456   ssize_t GetImageListIndex(const Image *images)
1457 </pre>
1458
1459 <p>A description of each parameter follows:</p></ol>
1460
1461 <h5>images</h5>
1462 <ol><p>the image list.</p></ol>
1463
1464  </div>
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">
1468
1469 <p>GetImageListSize() returns the number of images in the list.</p></ol>
1470
1471 <p>Deprecated, replace with:</p>
1472
1473 <pre class="text">
1474       GetImageListLength(images);
1475 </pre>
1476
1477 <p>The format of the GetImageListSize method is:</p>
1478
1479 <pre class="code">
1480   size_t GetImageListSize(const Image *images)
1481 </pre>
1482
1483 <p>A description of each parameter follows:</p></ol>
1484
1485 <h5>images</h5>
1486 <ol><p>the image list.</p></ol>
1487
1488  </div>
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">
1492
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>
1494
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>
1496
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>
1498
1499 <p>Deprecated, replace with:</p>
1500
1501 <pre class="text">
1502       GetAuthenticPixels(image,x,y,columns,rows,&image->exception);
1503 </pre>
1504
1505 <p>The format of the GetImagePixels() method is:</p>
1506
1507 <pre class="code">
1508   PixelPacket *GetImagePixels(Image *image,const ssize_t x,const ssize_t y,
1509     const size_t columns,const size_t rows)
1510 </pre>
1511
1512 <p>A description of each parameter follows:</p></ol>
1513
1514 <h5>image</h5>
1515 <ol><p>the image.</p></ol>
1516
1517 <h5>x,y,columns,rows</h5>
1518 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
1519
1520  </div>
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">
1524
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>
1526
1527 <p>Deprecated, replace with:</p>
1528
1529 <pre class="text">
1530       GetAuthenticIndexQueue(image);
1531 </pre>
1532
1533 <p>The format of the GetIndexes() method is:</p>
1534
1535 <pre class="code">
1536   IndexPacket *GetIndexes(const Image *image)
1537 </pre>
1538
1539 <p>A description of each parameter follows:</p></ol>
1540
1541 <h5>indexes</h5>
1542 <ol><p>GetIndexes() returns the indexes associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1543
1544 <h5>image</h5>
1545 <ol><p>the image.</p></ol>
1546
1547  </div>
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">
1551
1552 <p>GetNextImage() returns the next image in a list.</p></ol>
1553
1554 <p>Deprecated, replace with:</p>
1555
1556 <pre class="text">
1557       GetNextImageInList(images);
1558 </pre>
1559
1560 <p>The format of the GetNextImage method is:</p>
1561
1562 <pre class="code">
1563   Image *GetNextImage(const Image *images)
1564 </pre>
1565
1566 <p>A description of each parameter follows:</p></ol>
1567
1568 <h5>images</h5>
1569 <ol><p>the image list.</p></ol>
1570
1571  </div>
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">
1575
1576 <p>GetNextImageAttribute() gets the next image attribute.</p></ol>
1577
1578 <p>Deprecated, replace with:</p>
1579
1580 <pre class="text">
1581       const char *property;
1582       property=GetNextImageProperty(image);
1583       if (property != (const char *) NULL) 
1584   GetImageAttribute(image,property);
1585 </pre>
1586
1587 <p>The format of the GetNextImageAttribute method is:</p>
1588
1589 <pre class="code">
1590   const ImageAttribute *GetNextImageAttribute(const Image *image)
1591 </pre>
1592
1593 <p>A description of each parameter follows:</p></ol>
1594
1595 <h5>image</h5>
1596 <ol><p>the image.</p></ol>
1597
1598  </div>
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">
1602
1603 <p>GetNumberScenes() returns the number of images in the list.</p></ol>
1604
1605 <p>Deprecated, replace with:</p>
1606
1607 <pre class="text">
1608       GetImageListLength(image);
1609 </pre>
1610
1611 <p>The format of the GetNumberScenes method is:</p>
1612
1613 <pre class="code">
1614   unsigned int GetNumberScenes(const Image *images)
1615 </pre>
1616
1617 <p>A description of each parameter follows:</p></ol>
1618
1619 <h5>images</h5>
1620 <ol><p>the image list.</p></ol>
1621
1622  </div>
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">
1626
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>
1628
1629 <p>Deprecated, replace with:</p>
1630
1631 <pre class="text">
1632       GetOneAuthenticPixel(image,x,y,&pixel,&image->exception);
1633 </pre>
1634
1635 <p>The format of the GetOnePixel() method is:</p>
1636
1637 <pre class="code">
1638   PixelPacket GetOnePixel(const Image image,const ssize_t x,const ssize_t y)
1639 </pre>
1640
1641 <p>A description of each parameter follows:</p></ol>
1642
1643 <h5>image</h5>
1644 <ol><p>the image.</p></ol>
1645
1646 <h5>x,y</h5>
1647 <ol><p>These values define the location of the pixel to return.</p></ol>
1648
1649  </div>
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">
1653
1654 <p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1655
1656 <p>Deprecated, replace with:</p>
1657
1658 <pre class="text">
1659       GetAuthenticPixelQueue(image);
1660 </pre>
1661
1662 <p>The format of the GetPixels() method is:</p>
1663
1664 <pre class="code">
1665   PixelPacket *GetPixels(const Image image)
1666 </pre>
1667
1668 <p>A description of each parameter follows:</p></ol>
1669
1670 <h5>pixels</h5>
1671 <ol><p>GetPixels() returns the pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
1672
1673 <h5>image</h5>
1674 <ol><p>the image.</p></ol>
1675
1676  </div>
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">
1680
1681 <p>GetPreviousImage() returns the previous image in a list.</p></ol>
1682
1683 <p>Deprecated, replace with:</p>
1684
1685 <pre class="text">
1686       GetPreviousImageInList(images));
1687 </pre>
1688
1689 <p>The format of the GetPreviousImage method is:</p>
1690
1691 <pre class="code">
1692   Image *GetPreviousImage(const Image *images)
1693 </pre>
1694
1695 <p>A description of each parameter follows:</p></ol>
1696
1697 <h5>images</h5>
1698 <ol><p>the image list.</p></ol>
1699
1700  </div>
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">
1704
1705 <p>HSLTransform() converts a (hue, saturation, lightness) to a (red, green, blue) triple.</p></ol>
1706
1707 <p>The format of the HSLTransformImage method is:</p>
1708
1709 <pre class="code">
1710   void HSLTransform(const double hue,const double saturation,
1711     const double lightness,Quantum *red,Quantum *green,Quantum *blue)
1712 </pre>
1713
1714 <p>A description of each parameter follows:</p></ol>
1715
1716 <h5>hue, saturation, lightness</h5>
1717 <ol><p>A double value representing a component of the HSL color space.</p></ol>
1718
1719 <h5>red, green, blue</h5>
1720 <ol><p>A pointer to a pixel component of type Quantum.</p></ol>
1721
1722  </div>
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">
1726
1727 <p>IdentityAffine() initializes the affine transform to the identity matrix.</p></ol>
1728
1729 <p>The format of the IdentityAffine method is:</p>
1730
1731 <pre class="code">
1732   IdentityAffine(AffineMatrix *affine)
1733 </pre>
1734
1735 <p>A description of each parameter follows:</p></ol>
1736
1737 <h5>affine</h5>
1738 <ol><p>A pointer the affine transform of type AffineMatrix.</p></ol>
1739
1740  </div>
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">
1744
1745 <p>InitializeMagick() initializes the ImageMagick environment.</p></ol>
1746
1747 <p>Deprecated, replace with:</p>
1748
1749 <pre class="text">
1750       MagickCoreGenesis(path,MagickFalse);
1751 </pre>
1752
1753 <p>The format of the InitializeMagick function is:</p>
1754
1755 <pre class="text">
1756   InitializeMagick(const char *path)
1757 </pre>
1758
1759 <p>A description of each parameter follows:</p></ol>
1760
1761 <h5>path</h5>
1762 <ol><p>the execution path of the current ImageMagick client.</p></ol>
1763
1764  </div>
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">
1768
1769 <p>InterpolatePixelColor() applies bi-linear or tri-linear interpolation between a pixel and it's neighbors.</p></ol>
1770
1771 <p>The format of the InterpolatePixelColor method is:</p>
1772
1773 <pre class="code">
1774   MagickPixelPacket InterpolatePixelColor(const Image *image,
1775     CacheView *view_info,InterpolatePixelMethod method,const double x,
1776     const double y,ExceptionInfo *exception)
1777 </pre>
1778
1779 <p>A description of each parameter follows:</p></ol>
1780
1781 <h5>image</h5>
1782 <ol><p>the image.</p></ol>
1783
1784 <h5>image_view</h5>
1785 <ol><p>the image cache view.</p></ol>
1786
1787 <h5>type</h5>
1788 <ol><p>the type of pixel color interpolation.</p></ol>
1789
1790 <h5>x,y</h5>
1791 <ol><p>A double representing the current (x,y) position of the pixel.</p></ol>
1792
1793 <h5>exception</h5>
1794 <ol><p>return any errors or warnings in this structure.</p></ol>
1795
1796  </div>
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">
1800
1801 <p>InterpretImageAttributes() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
1802
1803 <p>Deprecated, replace with:</p>
1804
1805 <pre class="text">
1806       InterpretImageProperties(image_info,image,embed_text);
1807 </pre>
1808
1809 <p>The format of the InterpretImageAttributes method is:</p>
1810
1811 <pre class="code">
1812   char *InterpretImageAttributes(const ImageInfo *image_info,Image *image,
1813     const char *embed_text)
1814 </pre>
1815
1816 <p>A description of each parameter follows:</p></ol>
1817
1818 <h5>image_info</h5>
1819 <ol><p>the image info.</p></ol>
1820
1821 <h5>image</h5>
1822 <ol><p>the image.</p></ol>
1823
1824 <h5>embed_text</h5>
1825 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
1826
1827  </div>
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">
1831
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>
1833
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>
1835
1836 <p>Deprecated, replace with:</p>
1837
1838 <pre class="text">
1839       LevelColorsImageChannel(image,channel,black_color,white_color,invert);
1840 </pre>
1841
1842 <p>The format of the LevelImageColors method is:</p>
1843
1844 <pre class="code">
1845     MagickBooleanType LevelImageColors(Image *image,const ChannelType channel,
1846       const MagickPixelPacket *black_color,const MagickPixelPacket *white_color,
1847       const MagickBooleanType invert)
1848 </pre>
1849
1850 <p>A description of each parameter follows:</p></ol>
1851
1852 <h5>image</h5>
1853 <ol><p>the image.</p></ol>
1854
1855 <h5>channel</h5>
1856 <ol><p>the channel.</p></ol>
1857
1858 <h5>black_color</h5>
1859 <ol><p>The color to map black to/from</p></ol>
1860
1861 <h5>white_point</h5>
1862 <ol><p>The color to map white to/from</p></ol>
1863
1864 <h5>invert</h5>
1865 <ol><p>if true map the colors (levelize), rather than from (level)</p></ol>
1866
1867  </div>
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">
1871
1872 <p>LiberateMemory() frees memory that has already been allocated, and NULL's the pointer to it.</p></ol>
1873
1874 <p>The format of the LiberateMemory method is:</p>
1875
1876 <pre class="code">
1877   void LiberateMemory(void **memory)
1878 </pre>
1879
1880 <p>A description of each parameter follows:</p></ol>
1881
1882 <h5>memory</h5>
1883 <ol><p>A pointer to a block of memory to free for reuse.</p></ol>
1884
1885  </div>
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">
1889
1890 <p>LiberateSemaphoreInfo() relinquishes a semaphore.</p></ol>
1891
1892 <p>Deprecated, replace with:</p>
1893
1894 <pre class="text">
1895       UnlockSemaphoreInfo(*semaphore_info);
1896 </pre>
1897
1898 <p>The format of the LiberateSemaphoreInfo method is:</p>
1899
1900 <pre class="code">
1901   LiberateSemaphoreInfo(void **semaphore_info)
1902 </pre>
1903
1904 <p>A description of each parameter follows:</p></ol>
1905
1906 <h5>semaphore_info</h5>
1907 <ol><p>Specifies a pointer to an SemaphoreInfo structure.</p></ol>
1908
1909  </div>
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">
1913
1914 <p>MagickIncarnate() initializes the ImageMagick environment.</p></ol>
1915
1916 <p>Deprecated, replace with:</p>
1917
1918 <pre class="text">
1919       MagickCoreGenesis(path,MagickFalse);
1920 </pre>
1921
1922 <p>The format of the MagickIncarnate function is:</p>
1923
1924 <pre class="text">
1925   MagickIncarnate(const char *path)
1926 </pre>
1927
1928 <p>A description of each parameter follows:</p></ol>
1929
1930 <h5>path</h5>
1931 <ol><p>the execution path of the current ImageMagick client.</p></ol>
1932
1933  </div>
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">
1937
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>
1939
1940 <p>The format of the MagickMonitor method is:</p>
1941
1942 <pre class="code">
1943   MagickBooleanType MagickMonitor(const char *text,
1944     const MagickOffsetType offset,const MagickSizeType span,
1945     void *client_data)
1946 </pre>
1947
1948 <p>A description of each parameter follows:</p></ol>
1949
1950 <h5>offset</h5>
1951 <ol><p>the position relative to the span parameter which represents how much progress has been made toward completing a task.</p></ol>
1952
1953 <h5>span</h5>
1954 <ol><p>the span relative to completing a task.</p></ol>
1955
1956 <h5>client_data</h5>
1957 <ol><p>the client data.</p></ol>
1958
1959  </div>
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">
1963
1964 <p>MapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
1965
1966 <p>Deprecated, replace with:</p>
1967
1968 <pre class="text">
1969        QuantizeInfo quantize_info;
1970        GetQuantizeInfo(&quantize_info);
1971        quantize_info.dither=dither;
1972        RemapImage(&quantize_info,image,map_image);
1973 </pre>
1974
1975 <p>The format of the MapImage method is:</p>
1976
1977 <pre class="code">
1978   MagickBooleanType MapImage(Image *image,const Image *map_image,
1979     const MagickBooleanType dither)
1980 </pre>
1981
1982 <p>A description of each parameter follows:</p></ol>
1983
1984 <h5>image</h5>
1985 <ol><p>Specifies a pointer to an Image structure.</p></ol>
1986
1987 <h5>map_image</h5>
1988 <ol><p>the image.  Reduce image to a set of colors represented by this image.</p></ol>
1989
1990 <h5>dither</h5>
1991 <ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
1992
1993  </div>
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">
1997
1998 <p>MapImages() replaces the colors of a sequence of images with the closest color from a reference image.</p></ol>
1999
2000 <p>Deprecated, replace with:</p>
2001
2002 <pre class="text">
2003        QuantizeInfo quantize_info;
2004        GetQuantizeInfo(&quantize_info);
2005        quantize_info.dither=dither;
2006        RemapImages(&quantize_info,images,map_image);
2007 </pre>
2008
2009 <p>The format of the MapImage method is:</p>
2010
2011 <pre class="code">
2012   MagickBooleanType MapImages(Image *images,Image *map_image,
2013     const MagickBooleanType dither)
2014 </pre>
2015
2016 <p>A description of each parameter follows:</p></ol>
2017
2018 <h5>image</h5>
2019 <ol><p>Specifies a pointer to a set of Image structures.</p></ol>
2020
2021 <h5>map_image</h5>
2022 <ol><p>the image.  Reduce image to a set of colors represented by this image.</p></ol>
2023
2024 <h5>dither</h5>
2025 <ol><p>Set this integer value to something other than zero to dither the quantized image.</p></ol>
2026
2027  </div>
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">
2031
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>
2033
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>
2035
2036 <p>The format of the MatteFloodfillImage method is:</p>
2037
2038 <pre class="code">
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)
2042 </pre>
2043
2044 <p>A description of each parameter follows:</p></ol>
2045
2046 <h5>image</h5>
2047 <ol><p>the image.</p></ol>
2048
2049 <h5>target</h5>
2050 <ol><p>the RGB value of the target color.</p></ol>
2051
2052 <h5>opacity</h5>
2053 <ol><p>the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.</p></ol>
2054
2055 <h5>x,y</h5>
2056 <ol><p>the starting location of the operation.</p></ol>
2057
2058 <h5>method</h5>
2059 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
2060
2061  </div>
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">
2065
2066 <p>MaximumImages() returns the maximum intensity of an image sequence.</p></ol>
2067
2068 <p>Deprecated, replace with:</p>
2069
2070 <pre class="text">
2071       EvaluateImages(images,MinEvaluateOperator,exception);
2072 </pre>
2073
2074 <p>The format of the MaxImages method is:</p>
2075
2076 <pre class="code">
2077   Image *MaximumImages(Image *images,ExceptionInfo *exception)
2078 </pre>
2079
2080 <p>A description of each parameter follows:</p></ol>
2081
2082 <h5>images</h5>
2083 <ol><p>the image sequence.</p></ol>
2084
2085 <h5>exception</h5>
2086 <ol><p>return any errors or warnings in this structure.</p></ol>
2087
2088  </div>
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">
2092
2093 <p>MinimumImages() returns the minimum intensity of an image sequence.</p></ol>
2094
2095 <p>Deprecated, replace with:</p>
2096
2097 <pre class="text">
2098       EvaluateImages(images,MinEvaluateOperator,exception);
2099 </pre>
2100
2101 <p>The format of the MinimumImages method is:</p>
2102
2103 <pre class="code">
2104   Image *MinimumImages(Image *images,ExceptionInfo *exception)
2105 </pre>
2106
2107 <p>A description of each parameter follows:</p></ol>
2108
2109 <h5>images</h5>
2110 <ol><p>the image sequence.</p></ol>
2111
2112 <h5>exception</h5>
2113 <ol><p>return any errors or warnings in this structure.</p></ol>
2114
2115  </div>
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">
2119
2120 <p>MosaicImages() Obsolete Function: Use MergeImageLayers() instead.</p></ol>
2121
2122 <p>Deprecated, replace with:</p>
2123
2124 <pre class="text">
2125       MergeImageLayers(image,MosaicLayer,exception);
2126 </pre>
2127
2128 <p>The format of the MosaicImage method is:</p>
2129
2130 <pre class="code">
2131   Image *MosaicImages(const Image *image,ExceptionInfo *exception)
2132 </pre>
2133
2134 <p>A description of each parameter follows:</p></ol>
2135
2136 <h5>image</h5>
2137 <ol><p>the image list to be composited together</p></ol>
2138
2139 <h5>exception</h5>
2140 <ol><p>return any errors or warnings in this structure.</p></ol>
2141
2142  </div>
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">
2146
2147 <p>OpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
2148
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>
2150
2151 <p>The format of the OpaqueImage method is:</p>
2152
2153 <pre class="code">
2154   MagickBooleanType OpaqueImage(Image *image,
2155     const PixelPacket *target,const PixelPacket fill)
2156 </pre>
2157
2158 <p>A description of each parameter follows:</p></ol>
2159
2160 <h5>image</h5>
2161 <ol><p>the image.</p></ol>
2162
2163 <h5>target</h5>
2164 <ol><p>the RGB value of the target color.</p></ol>
2165
2166 <h5>fill</h5>
2167 <ol><p>the replacement color.</p></ol>
2168
2169  </div>
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">
2173
2174 <p>OpenCacheView() opens a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
2175
2176 <p>Deprecated, replace with:</p>
2177
2178 <pre class="text">
2179       AcquireCacheView(image);
2180 </pre>
2181
2182 <p>The format of the OpenCacheView method is:</p>
2183
2184 <pre class="code">
2185   CacheView *OpenCacheView(const Image *image)
2186 </pre>
2187
2188 <p>A description of each parameter follows:</p></ol>
2189
2190 <h5>image</h5>
2191 <ol><p>the image.</p></ol>
2192
2193  </div>
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">
2197
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>
2199
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>
2201
2202 <p>Deprecated, replace with:</p>
2203
2204 <pre class="text">
2205       FloodfillPaintImage(image,channel,draw_info,target,x,y,
2206   method == FloodfillMethod ? MagickFalse : MagickTrue);
2207 </pre>
2208
2209 <p>The format of the PaintFloodfillImage method is:</p>
2210
2211 <pre class="code">
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)
2215 </pre>
2216
2217 <p>A description of each parameter follows:</p></ol>
2218
2219 <h5>image</h5>
2220 <ol><p>the image.</p></ol>
2221
2222 <h5>channel</h5>
2223 <ol><p>the channel(s).</p></ol>
2224
2225 <h5>target</h5>
2226 <ol><p>the RGB value of the target color.</p></ol>
2227
2228 <h5>x,y</h5>
2229 <ol><p>the starting location of the operation.</p></ol>
2230
2231 <h5>draw_info</h5>
2232 <ol><p>the draw info.</p></ol>
2233
2234 <h5>method</h5>
2235 <ol><p>Choose either FloodfillMethod or FillToBorderMethod.</p></ol>
2236
2237  </div>
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">
2241
2242 <p>PaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
2243
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>
2245
2246 <p>Deprecated, replace with:</p>
2247
2248 <pre class="text">
2249       OpaquePaintImageChannel(image,DefaultChannels,target,fill,MagickFalse);
2250       OpaquePaintImageChannel(image,channel,target,fill,MagickFalse);
2251 </pre>
2252
2253 <p>The format of the PaintOpaqueImage method is:</p>
2254
2255 <pre class="code">
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)
2261 </pre>
2262
2263 <p>A description of each parameter follows:</p></ol>
2264
2265 <h5>image</h5>
2266 <ol><p>the image.</p></ol>
2267
2268 <h5>channel</h5>
2269 <ol><p>the channel(s).</p></ol>
2270
2271 <h5>target</h5>
2272 <ol><p>the RGB value of the target color.</p></ol>
2273
2274 <h5>fill</h5>
2275 <ol><p>the replacement color.</p></ol>
2276
2277  </div>
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">
2281
2282 <p>PaintTransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
2283
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>
2285
2286 <p>Deprecated, replace with:</p>
2287
2288 <pre class="text">
2289       TransparentPaintImage(image,target,opacity,MagickFalse);
2290 </pre>
2291
2292 <p>The format of the PaintTransparentImage method is:</p>
2293
2294 <pre class="code">
2295   MagickBooleanType PaintTransparentImage(Image *image,
2296     const MagickPixelPacket *target,const Quantum opacity)
2297 </pre>
2298
2299 <p>A description of each parameter follows:</p></ol>
2300
2301 <h5>image</h5>
2302 <ol><p>the image.</p></ol>
2303
2304 <h5>target</h5>
2305 <ol><p>the RGB value of the target color.</p></ol>
2306
2307 <h5>opacity</h5>
2308 <ol><p>the replacement opacity value.</p></ol>
2309
2310  </div>
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">
2314
2315 <p>ParseSizeGeometry() returns a region as defined by the geometry string with respect to the image dimensions and aspect ratio.</p></ol>
2316
2317 <p>Deprecated, replace with:</p>
2318
2319 <pre class="text">
2320       ParseMetaGeometry(geometry,&region_info->x,&region_info->y,
2321   &region_info->width,&region_info->height);
2322 </pre>
2323
2324 <p>The format of the ParseSizeGeometry method is:</p>
2325
2326 <pre class="code">
2327   MagickStatusType ParseSizeGeometry(const Image *image,
2328     const char *geometry,RectangeInfo *region_info)
2329 </pre>
2330
2331 <p>A description of each parameter follows:</p></ol>
2332
2333 <h5>geometry</h5>
2334 <ol><p>The geometry (e.g. 100x100+10+10).</p></ol>
2335
2336 <h5>region_info</h5>
2337 <ol><p>the region as defined by the geometry string.</p></ol>
2338
2339  </div>
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">
2343
2344 <p>PopImageList() removes the last image in the list.</p></ol>
2345
2346 <p>Deprecated, replace with:</p>
2347
2348 <pre class="text">
2349       RemoveLastImageFromList(images);
2350 </pre>
2351
2352 <p>The format of the PopImageList method is:</p>
2353
2354 <pre class="code">
2355   Image *PopImageList(Image **images)
2356 </pre>
2357
2358 <p>A description of each parameter follows:</p></ol>
2359
2360 <h5>images</h5>
2361 <ol><p>the image list.</p></ol>
2362
2363  </div>
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">
2367
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>
2369
2370 <p>The format of the PopImagePixels method is:</p>
2371
2372 <pre class="code">
2373   size_t PopImagePixels(Image *,const QuantumType quantum,
2374     unsigned char *destination)
2375 </pre>
2376
2377 <p>A description of each parameter follows:</p></ol>
2378
2379 <h5>image</h5>
2380 <ol><p>the image.</p></ol>
2381
2382 <h5>quantum</h5>
2383 <ol><p>Declare which pixel components to transfer (RGB, RGBA, etc).</p></ol>
2384
2385 <h5>destination</h5>
2386 <ol><p>The components are transferred to this buffer.</p></ol>
2387
2388  </div>
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">
2392
2393 <p>PostscriptGeometry() replaces any page mneumonic with the equivalent size in picas.</p></ol>
2394
2395 <p>Deprecated, replace with:</p>
2396
2397 <pre class="text">
2398       GetPageGeometry(page);
2399 </pre>
2400
2401 <p>The format of the PostscriptGeometry method is:</p>
2402
2403 <pre class="code">
2404   char *PostscriptGeometry(const char *page)
2405 </pre>
2406
2407 <p>A description of each parameter follows.</p></ol>
2408
2409 <h5> page</h5>
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>
2411
2412  </div>
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">
2416
2417 <p>PushImageList() adds an image to the end of the list.</p></ol>
2418
2419 <p>Deprecated, replace with:</p>
2420
2421 <pre class="text">
2422       AppendImageToList(images,CloneImageList(image,exception));
2423 </pre>
2424
2425 <p>The format of the PushImageList method is:</p>
2426
2427 <pre class="code">
2428   unsigned int PushImageList(Image *images,const Image *image,
2429     ExceptionInfo *exception)
2430 </pre>
2431
2432 <p>A description of each parameter follows:</p></ol>
2433
2434 <h5>images</h5>
2435 <ol><p>the image list.</p></ol>
2436
2437 <h5>image</h5>
2438 <ol><p>the image.</p></ol>
2439
2440 <h5>exception</h5>
2441 <ol><p>return any errors or warnings in this structure.</p></ol>
2442
2443  </div>
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">
2447
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>
2449
2450 <p>The format of the PushImagePixels method is:</p>
2451
2452 <pre class="code">
2453   size_t PushImagePixels(Image *image,const QuantumType quantum,
2454     const unsigned char *source)
2455 </pre>
2456
2457 <p>A description of each parameter follows:</p></ol>
2458
2459 <h5>image</h5>
2460 <ol><p>the image.</p></ol>
2461
2462 <h5>quantum</h5>
2463 <ol><p>Declare which pixel components to transfer (red, green, blue, opacity, RGB, or RGBA).</p></ol>
2464
2465 <h5>source</h5>
2466 <ol><p>The pixel components are transferred from this buffer.</p></ol>
2467
2468  </div>
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">
2472
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>
2474
2475 <pre class="text">
2476       o mean_error_per_pixel:  This value is the mean error for any single
2477   pixel in the image.
2478 </pre>
2479
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>
2482
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>
2485
2486 <p>Deprecated, replace with:</p>
2487
2488 <pre class="text">
2489       GetImageQuantizeError(image);
2490 </pre>
2491
2492 <p>The format of the QuantizationError method is:</p>
2493
2494 <pre class="code">
2495   unsigned int QuantizationError(Image *image)
2496 </pre>
2497
2498 <p>A description of each parameter follows.</p></ol>
2499
2500 <h5>image</h5>
2501 <ol><p>Specifies a pointer to an Image structure;  returned from ReadImage.</p></ol>
2502
2503  </div>
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">
2507
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>
2509
2510 <p>The format of the RandomChannelThresholdImage method is:</p>
2511
2512 <pre class="code">
2513   unsigned int RandomChannelThresholdImage(Image *image,
2514      const char *channel, const char *thresholds,
2515      ExceptionInfo *exception)
2516 </pre>
2517
2518 <p>A description of each parameter follows:</p></ol>
2519
2520 <h5>image</h5>
2521 <ol><p>the image.</p></ol>
2522
2523 <h5>channel</h5>
2524 <ol><p>the channel or channels to be thresholded.</p></ol>
2525
2526 <h5>thresholds</h5>
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>
2528
2529 <h5>exception</h5>
2530 <ol><p>return any errors or warnings in this structure.</p></ol>
2531
2532  </div>
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">
2536
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>
2538
2539 <p>The format of the ReacquireMemory method is:</p>
2540
2541 <pre class="code">
2542   void ReacquireMemory(void **memory,const size_t size)
2543 </pre>
2544
2545 <p>A description of each parameter follows:</p></ol>
2546
2547 <h5>memory</h5>
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>
2549
2550 <h5>size</h5>
2551 <ol><p>the new size of the allocated memory.</p></ol>
2552
2553  </div>
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">
2557
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>
2559
2560 <p>The format of the RecolorImage method is:</p>
2561
2562 <pre class="code">
2563   Image *RecolorImage(const Image *image,const size_t order,
2564     const double *color_matrix,ExceptionInfo *exception)
2565 </pre>
2566
2567 <p>A description of each parameter follows:</p></ol>
2568
2569 <h5>image</h5>
2570 <ol><p>the image.</p></ol>
2571
2572 <h5>order</h5>
2573 <ol><p>the number of columns and rows in the recolor matrix.</p></ol>
2574
2575 <h5>color_matrix</h5>
2576 <ol><p>An array of double representing the recolor matrix.</p></ol>
2577
2578 <h5>exception</h5>
2579 <ol><p>return any errors or warnings in this structure.</p></ol>
2580
2581  </div>
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">
2585
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>
2587
2588 <p>Deprecated, replace with:</p>
2589
2590 <pre class="text">
2591       ResetImagePropertyIterator(image);
2592 </pre>
2593
2594 <p>The format of the ResetImageAttributeIterator method is:</p>
2595
2596 <pre class="code">
2597   ResetImageAttributeIterator(const ImageInfo *image)
2598 </pre>
2599
2600 <p>A description of each parameter follows:</p></ol>
2601
2602 <h5>image</h5>
2603 <ol><p>the image.</p></ol>
2604
2605  </div>
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">
2609
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>
2611
2612 <p>Deprecated, replace with:</p>
2613
2614 <pre class="text">
2615       QueueCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
2616   GetCacheViewException(cache_view));
2617 </pre>
2618
2619 <p>The format of the SetCacheViewPixels method is:</p>
2620
2621 <pre class="code">
2622   PixelPacket *SetCacheViewPixels(CacheView *cache_view,const ssize_t x,
2623     const ssize_t y,const size_t columns,const size_t rows)
2624 </pre>
2625
2626 <p>A description of each parameter follows:</p></ol>
2627
2628 <h5>cache_view</h5>
2629 <ol><p>the cache view.</p></ol>
2630
2631 <h5>x,y,columns,rows</h5>
2632 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
2633
2634  </div>
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">
2638
2639 <p>SetExceptionInfo() sets the exception severity.</p></ol>
2640
2641 <p>The format of the SetExceptionInfo method is:</p>
2642
2643 <pre class="code">
2644   MagickBooleanType SetExceptionInfo(ExceptionInfo *exception,
2645     ExceptionType severity)
2646 </pre>
2647
2648 <p>A description of each parameter follows:</p></ol>
2649
2650 <h5>exception</h5>
2651 <ol><p>the exception info.</p></ol>
2652
2653 <h5>severity</h5>
2654 <ol><p>the exception severity.</p></ol>
2655
2656  </div>
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">
2660
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>
2662
2663 <p>The format of the SetImage method is:</p>
2664
2665 <pre class="code">
2666   void SetImage(Image *image,const Quantum opacity)
2667 </pre>
2668
2669 <p>A description of each parameter follows:</p></ol>
2670
2671 <h5>image</h5>
2672 <ol><p>the image.</p></ol>
2673
2674 <h5>opacity</h5>
2675 <ol><p>Set each pixel to this level of transparency.</p></ol>
2676
2677  </div>
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">
2681
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>
2683
2684 <p>Deprecated, replace with:</p>
2685
2686 <pre class="text">
2687       SetImageProperty(image,key,value);
2688 </pre>
2689
2690 <p>The format of the SetImageAttribute method is:</p>
2691
2692 <pre class="code">
2693    MagickBooleanType SetImageAttribute(Image *image,const char *key,
2694      const char *value)
2695 </pre>
2696
2697 <p>A description of each parameter follows:</p></ol>
2698
2699 <h5>image</h5>
2700 <ol><p>the image.</p></ol>
2701
2702 <h5>key</h5>
2703 <ol><p>the key.</p></ol>
2704
2705 <h5>value</h5>
2706 <ol><p>the value.</p></ol>
2707
2708  </div>
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">
2712
2713 <p>SetImageList() inserts an image into the list at the specified position.</p></ol>
2714
2715 <p>The format of the SetImageList method is:</p>
2716
2717 <pre class="code">
2718   unsigned int SetImageList(Image *images,const Image *image,
2719     const ssize_t offset,ExceptionInfo *exception)
2720 </pre>
2721
2722 <p>A description of each parameter follows:</p></ol>
2723
2724 <h5>images</h5>
2725 <ol><p>the image list.</p></ol>
2726
2727 <h5>image</h5>
2728 <ol><p>the image.</p></ol>
2729
2730 <h5>offset</h5>
2731 <ol><p>the position within the list.</p></ol>
2732
2733 <h5>exception</h5>
2734 <ol><p>return any errors or warnings in this structure.</p></ol>
2735
2736  </div>
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">
2740
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>
2742
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>
2744
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>
2746
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>
2748
2749 <p>Deprecated, replace with:</p>
2750
2751 <pre class="text">
2752       QueueAuthenticPixels(image,x,y,columns,rows,&image->exception);
2753 </pre>
2754
2755 <p>The format of the SetImagePixels() method is:</p>
2756
2757 <pre class="code">
2758   PixelPacket *SetImagePixels(Image *image,const ssize_t x,const ssize_t y,
2759     const size_t columns,const size_t rows)
2760 </pre>
2761
2762 <p>A description of each parameter follows:</p></ol>
2763
2764 <h5>pixels</h5>
2765 <ol><p>SetImagePixels returns a pointer to the pixels if they are transferred, otherwise a NULL is returned.</p></ol>
2766
2767 <h5>image</h5>
2768 <ol><p>the image.</p></ol>
2769
2770 <h5>x,y,columns,rows</h5>
2771 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
2772
2773  </div>
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">
2777
2778 <p>SetMagickRegistry() sets a blob into the registry and returns a unique ID. If an error occurs, -1 is returned.</p></ol>
2779
2780 <p>The format of the SetMagickRegistry method is:</p>
2781
2782 <pre class="code">
2783   ssize_t SetMagickRegistry(const RegistryType type,const void *blob,
2784     const size_t length,ExceptionInfo *exception)
2785 </pre>
2786
2787 <p>A description of each parameter follows:</p></ol>
2788
2789 <h5>type</h5>
2790 <ol><p>the registry type.</p></ol>
2791
2792 <h5>blob</h5>
2793 <ol><p>the address of a Binary Large OBject.</p></ol>
2794
2795 <h5>length</h5>
2796 <ol><p>For a registry type of ImageRegistryType use sizeof(Image) otherise the blob length in number of bytes.</p></ol>
2797
2798 <h5>exception</h5>
2799 <ol><p>return any errors or warnings in this structure.</p></ol>
2800
2801  </div>
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">
2805
2806 <p>SetMonitorHandler() sets the monitor handler to the specified method and returns the previous monitor handler.</p></ol>
2807
2808 <p>The format of the SetMonitorHandler method is:</p>
2809
2810 <pre class="code">
2811   MonitorHandler SetMonitorHandler(MonitorHandler handler)
2812 </pre>
2813
2814 <p>A description of each parameter follows:</p></ol>
2815
2816 <h5>handler</h5>
2817 <ol><p>Specifies a pointer to a method to handle monitors.</p></ol>
2818
2819  </div>
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">
2823
2824 <p>ShiftImageList() removes an image from the beginning of the list.</p></ol>
2825
2826 <p>Deprecated, replace with:</p>
2827
2828 <pre class="text">
2829       RemoveFirstImageFromList(images);
2830 </pre>
2831
2832 <p>The format of the ShiftImageList method is:</p>
2833
2834 <pre class="code">
2835   Image *ShiftImageList(Image **images)
2836 </pre>
2837
2838 <p>A description of each parameter follows:</p></ol>
2839
2840 <h5>images</h5>
2841 <ol><p>the image list.</p></ol>
2842
2843  </div>
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">
2847
2848 <p>SpliceImageList() removes the images designated by offset and length from the list and replaces them with the specified list.</p></ol>
2849
2850 <p>The format of the SpliceImageList method is:</p>
2851
2852 <pre class="code">
2853   Image *SpliceImageList(Image *images,const ssize_t offset,
2854     const size_t length,const Image *splices,
2855     ExceptionInfo *exception)
2856 </pre>
2857
2858 <p>A description of each parameter follows:</p></ol>
2859
2860 <h5>images</h5>
2861 <ol><p>the image list.</p></ol>
2862
2863 <h5>offset</h5>
2864 <ol><p>the position within the list.</p></ol>
2865
2866 <h5>length</h5>
2867 <ol><p>the length of the image list to remove.</p></ol>
2868
2869 <h5>splice</h5>
2870 <ol><p>Replace the removed image list with this list.</p></ol>
2871
2872 <h5>exception</h5>
2873 <ol><p>return any errors or warnings in this structure.</p></ol>
2874
2875  </div>
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">
2879
2880 <p>Strip() strips any whitespace or quotes from the beginning and end of a string of characters.</p></ol>
2881
2882 <p>The format of the Strip method is:</p>
2883
2884 <pre class="code">
2885   void Strip(char *message)
2886 </pre>
2887
2888 <p>A description of each parameter follows:</p></ol>
2889
2890 <h5>message</h5>
2891 <ol><p>Specifies an array of characters.</p></ol>
2892
2893  </div>
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">
2897
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>
2899
2900 <p>Deprecated, replace with:</p>
2901
2902 <pre class="text">
2903       SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
2904 </pre>
2905
2906 <p>The format of the SyncCacheView method is:</p>
2907
2908 <pre class="code">
2909   MagickBooleanType SyncCacheView(CacheView *cache_view)
2910 </pre>
2911
2912 <p>A description of each parameter follows:</p></ol>
2913
2914 <h5>cache_view</h5>
2915 <ol><p>the cache view.</p></ol>
2916
2917  </div>
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">
2921
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>
2923
2924 <p>Deprecated, replace with:</p>
2925
2926 <pre class="text">
2927       SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
2928 </pre>
2929
2930 <p>The format of the SyncCacheViewPixels method is:</p>
2931
2932 <pre class="code">
2933   MagickBooleanType SyncCacheViewPixels(CacheView *cache_view)
2934 </pre>
2935
2936 <p>A description of each parameter follows:</p></ol>
2937
2938 <h5>cache_view</h5>
2939 <ol><p>the cache view.</p></ol>
2940
2941 <h5>exception</h5>
2942 <ol><p>return any errors or warnings in this structure.</p></ol>
2943
2944  </div>
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">
2948
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>
2950
2951 <p>Deprecated, replace with:</p>
2952
2953 <pre class="text">
2954       SyncAuthenticPixels(image,&image->exception);
2955 </pre>
2956
2957 <p>The format of the SyncImagePixels() method is:</p>
2958
2959 <pre class="code">
2960   MagickBooleanType SyncImagePixels(Image *image)
2961 </pre>
2962
2963 <p>A description of each parameter follows:</p></ol>
2964
2965 <h5>image</h5>
2966 <ol><p>the image.</p></ol>
2967
2968  </div>
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">
2972
2973 <p>TemporaryFilename() replaces the contents of path by a unique path name.</p></ol>
2974
2975 <p>The format of the TemporaryFilename method is:</p>
2976
2977 <pre class="code">
2978   void TemporaryFilename(char *path)
2979 </pre>
2980
2981 <p>A description of each parameter follows.</p></ol>
2982
2983 <h5> path</h5>
2984 <ol><p>Specifies a pointer to an array of characters.  The unique path name is returned in this array.</p></ol>
2985
2986  </div>
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">
2990
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>
2992
2993 <p>The format of the ThresholdImage method is:</p>
2994
2995 <pre class="code">
2996   unsigned int ThresholdImage(Image *image,const double threshold)
2997 </pre>
2998
2999 <p>A description of each parameter follows:</p></ol>
3000
3001 <h5>image</h5>
3002 <ol><p>the image.</p></ol>
3003
3004 <h5>threshold</h5>
3005 <ol><p>Define the threshold value</p></ol>
3006
3007  </div>
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">
3011
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>
3013
3014 <p>The format of the ThresholdImageChannel method is:</p>
3015
3016 <pre class="code">
3017   unsigned int ThresholdImageChannel(Image *image,const char *threshold)
3018 </pre>
3019
3020 <p>A description of each parameter follows:</p></ol>
3021
3022 <h5>image</h5>
3023 <ol><p>the image.</p></ol>
3024
3025 <h5>threshold</h5>
3026 <ol><p>define the threshold values.</p></ol>
3027
3028  </div>
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">
3032
3033 <p>TransformHSL() converts a (red, green, blue) to a (hue, saturation, lightness) triple.</p></ol>
3034
3035 <p>The format of the TransformHSL method is:</p>
3036
3037 <pre class="code">
3038   void TransformHSL(const Quantum red,const Quantum green,
3039     const Quantum blue,double *hue,double *saturation,double *lightness)
3040 </pre>
3041
3042 <p>A description of each parameter follows:</p></ol>
3043
3044 <h5>red, green, blue</h5>
3045 <ol><p>A Quantum value representing the red, green, and blue component of a pixel..</p></ol>
3046
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>
3049
3050  </div>
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">
3054
3055 <p>TranslateText() replaces any embedded formatting characters with the appropriate image attribute and returns the translated text.</p></ol>
3056
3057 <p>Deprecated, replace with:</p>
3058
3059 <pre class="text">
3060       InterpretImageProperties(image_info,image,embed_text);
3061 </pre>
3062
3063 <p>The format of the TranslateText method is:</p>
3064
3065 <pre class="code">
3066   char *TranslateText(const ImageInfo *image_info,Image *image,
3067     const char *embed_text)
3068 </pre>
3069
3070 <p>A description of each parameter follows:</p></ol>
3071
3072 <h5>image_info</h5>
3073 <ol><p>the image info.</p></ol>
3074
3075 <h5>image</h5>
3076 <ol><p>the image.</p></ol>
3077
3078 <h5>embed_text</h5>
3079 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
3080
3081  </div>
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">
3085
3086 <p>TransparentImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.</p></ol>
3087
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>
3089
3090 <p>The format of the TransparentImage method is:</p>
3091
3092 <pre class="code">
3093   MagickBooleanType TransparentImage(Image *image,
3094     const PixelPacket target,const Quantum opacity)
3095 </pre>
3096
3097 <p>A description of each parameter follows:</p></ol>
3098
3099 <h5>image</h5>
3100 <ol><p>the image.</p></ol>
3101
3102 <h5>target</h5>
3103 <ol><p>the RGB value of the target color.</p></ol>
3104
3105 <h5>opacity</h5>
3106 <ol><p>the replacement opacity value.</p></ol>
3107
3108  </div>
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">
3112
3113 <p>UnshiftImageList() adds the image to the beginning of the list.</p></ol>
3114
3115 <p>Deprecated, replace with:</p>
3116
3117 <pre class="text">
3118       PrependImageToList(images,CloneImageList(image,exception));
3119 </pre>
3120
3121 <p>The format of the UnshiftImageList method is:</p>
3122
3123 <pre class="code">
3124   unsigned int UnshiftImageList(Image *images,const Image *image,
3125     ExceptionInfo *exception)
3126 </pre>
3127
3128 <p>A description of each parameter follows:</p></ol>
3129
3130 <h5>images</h5>
3131 <ol><p>the image list.</p></ol>
3132
3133 <h5>image</h5>
3134 <ol><p>the image.</p></ol>
3135
3136 <h5>exception</h5>
3137 <ol><p>return any errors or warnings in this structure.</p></ol>
3138
3139  </div>
3140 \r
3141 </div>\r
3142 \r
3143 <div id="linkbar">\r
3144  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
3145     <span id="linkbar-center">\r
3146       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
3147     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
3148     </span>\r
3149     <span id="linkbar-east">&nbsp;</span>\r
3150   </div>\r
3151   <div class="footer">\r
3152     <span id="footer-west">&copy; 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
3154   </div>\r
3155   <div style="clear: both; margin: 0; width: 100%; "></div>\r
3156 </body>\r
3157 </html>\r