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