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