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