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