Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 0291e2d8de5edfe069fb08954dfec7f2872c5127 / . / www / api / magick-deprecate.html
blob: 7de4ccc15b5219ed99f40a3df441d963b5b9725f [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +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">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +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: MagickWand, 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="magickwc, 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"/>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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>
cristy3eaa0ef2010-03-06 20:35:26 +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">
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame^]127 <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
128</div>
129<div class="sponsor">
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]130 <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
131</div>
132<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]133 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
cristy5f2356f2009-11-16 00:40:46 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristycdbe2742010-02-07 19:30:44 +0000[diff] [blame]136 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]139 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]142 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
148</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]149
150
151</div>
152
153<div class="main">
154
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame^]155<p class="navigation-index">[<a href="#MagickAverageImages">MagickAverageImages</a> &bull; <a href="#MagickClipPathImage">MagickClipPathImage</a> &bull; <a href="#DrawGetFillAlpha">DrawGetFillAlpha</a> &bull; <a href="#DrawGetStrokeAlpha">DrawGetStrokeAlpha</a> &bull; <a href="#DrawPeekGraphicWand">DrawPeekGraphicWand</a> &bull; <a href="#DrawPopGraphicContext">DrawPopGraphicContext</a> &bull; <a href="#DrawPushGraphicContext">DrawPushGraphicContext</a> &bull; <a href="#DrawSetFillAlpha">DrawSetFillAlpha</a> &bull; <a href="#DrawSetStrokeAlpha">DrawSetStrokeAlpha</a> &bull; <a href="#MagickColorFloodfillImage">MagickColorFloodfillImage</a> &bull; <a href="#MagickDescribeImage">MagickDescribeImage</a> &bull; <a href="#MagickFlattenImages">MagickFlattenImages</a> &bull; <a href="#MagickGetImageAttribute">MagickGetImageAttribute</a> &bull; <a href="#MagickGetImageMatte">MagickGetImageMatte</a> &bull; <a href="#MagickGetImagePixels">MagickGetImagePixels</a> &bull; <a href="#MagickGetImageSize">MagickGetImageSize</a> &bull; <a href="#MagickMapImage">MagickMapImage</a> &bull; <a href="#MagickMatteFloodfillImage">MagickMatteFloodfillImage</a> &bull; <a href="#MagickMaximumImages">MagickMaximumImages</a> &bull; <a href="#MagickMinimumImages">MagickMinimumImages</a> &bull; <a href="#MagickMosaicImages">MagickMosaicImages</a> &bull; <a href="#MagickOpaqueImage">MagickOpaqueImage</a> &bull; <a href="#MagickPaintFloodfillImage">MagickPaintFloodfillImage</a> &bull; <a href="#MagickPaintOpaqueImage">MagickPaintOpaqueImage</a> &bull; <a href="#MagickPaintTransparentImage">MagickPaintTransparentImage</a> &bull; <a href="#MagickRecolorImage">MagickRecolorImage</a> &bull; <a href="#MagickSetImageAttribute">MagickSetImageAttribute</a> &bull; <a href="#MagickSetImageIndex">MagickSetImageIndex</a> &bull; <a href="#MagickTransparentImage">MagickTransparentImage</a> &bull; <a href="#MagickRegionOfInterestImage">MagickRegionOfInterestImage</a> &bull; <a href="#MagickSetImagePixels">MagickSetImagePixels</a> &bull; <a href="#MagickWriteImageBlob">MagickWriteImageBlob</a> &bull; <a href="#PixelGetNextRow">PixelGetNextRow</a> &bull; <a href="#PixelIteratorGetException">PixelIteratorGetException</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]156
157<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]158_8c.html" target="source" name="MagickAverageImages">MagickAverageImages</a></h2>
159<div class="doc-section">
160
161<p>MagickAverageImages() average a set of images.</p></ol>
162
163<p>The format of the MagickAverageImages method is:</p>
164
165<pre class="code">
166 MagickWand *MagickAverageImages(MagickWand *wand)
167</pre>
168
169<p>A description of each parameter follows:</p></ol>
170
171<h5>wand</h5>
172<ol><p>the magick wand.</p></ol>
173
174 </div>
175<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]176_8c.html" target="source" name="MagickClipPathImage">MagickClipPathImage</a></h2>
177<div class="doc-section">
178
179<p>MagickClipPathImage() clips along the named paths from the 8BIM profile, if present. Later operations take effect inside the path. Id may be a number if preceded with #, to work on a numbered path, e.g., "#1" to use the first path.</p></ol>
180
181<p>The format of the MagickClipPathImage method is:</p>
182
183<pre class="code">
184 MagickBooleanType MagickClipPathImage(MagickWand *wand,
185 const char *pathname,const MagickBooleanType inside)
186</pre>
187
188<p>A description of each parameter follows:</p></ol>
189
190<h5>wand</h5>
191<ol><p>the magick wand.</p></ol>
192
193<h5>pathname</h5>
194<ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
195
196<h5>inside</h5>
197<ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
198
199 </div>
200<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
201_8c.html" target="source" name="DrawGetFillAlpha">DrawGetFillAlpha</a></h2>
202<div class="doc-section">
203
204<p>DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture. Fully opaque is 1.0.</p></ol>
205
206<p>The format of the DrawGetFillAlpha method is:</p>
207
208<pre class="code">
209 double DrawGetFillAlpha(const DrawingWand *wand)
210</pre>
211
212<p>A description of each parameter follows:</p></ol>
213
214<h5>wand</h5>
215<ol><p>the drawing wand.</p></ol>
216
217 </div>
218<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
219_8c.html" target="source" name="DrawGetStrokeAlpha">DrawGetStrokeAlpha</a></h2>
220<div class="doc-section">
221
222<p>DrawGetStrokeAlpha() returns the alpha of stroked object outlines.</p></ol>
223
224<p>The format of the DrawGetStrokeAlpha method is:</p>
225
226<pre class="code">
227 double DrawGetStrokeAlpha(const DrawingWand *wand)
228</pre>
229
230<p>A description of each parameter follows:</p></ol>
231
232<h5>wand</h5>
233<ol><p>the drawing wand. </p>
234 </div>
235<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
236_8c.html" target="source" name="DrawPeekGraphicWand">DrawPeekGraphicWand</a></h2>
237<div class="doc-section">
238
239<p>DrawPeekGraphicWand() returns the current drawing wand.</p></ol>
240
241<p>The format of the PeekDrawingWand method is:</p>
242
243<pre class="code">
244 DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
245</pre>
246
247<p>A description of each parameter follows:</p></ol>
248
249<h5>wand</h5>
250<ol><p>the drawing wand.</p></ol>
251
252 </div>
253<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
254_8c.html" target="source" name="DrawPopGraphicContext">DrawPopGraphicContext</a></h2>
255<div class="doc-section">
256
257<p>DrawPopGraphicContext() destroys the current drawing wand and returns to the previously pushed drawing wand. Multiple drawing wands may exist. It is an error to attempt to pop more drawing wands than have been pushed, and it is proper form to pop all drawing wands which have been pushed.</p></ol>
258
259<p>The format of the DrawPopGraphicContext method is:</p>
260
261<pre class="code">
262 MagickBooleanType DrawPopGraphicContext(DrawingWand *wand)
263</pre>
264
265<p>A description of each parameter follows:</p></ol>
266
267<h5>wand</h5>
268<ol><p>the drawing wand.</p></ol>
269
270 </div>
271<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
272_8c.html" target="source" name="DrawPushGraphicContext">DrawPushGraphicContext</a></h2>
273<div class="doc-section">
274
275<p>DrawPushGraphicContext() clones the current drawing wand to create a new drawing wand. The original drawing wand(s) may be returned to by invoking PopDrawingWand(). The drawing wands are stored on a drawing wand stack. For every Pop there must have already been an equivalent Push.</p></ol>
276
277<p>The format of the DrawPushGraphicContext method is:</p>
278
279<pre class="code">
280 MagickBooleanType DrawPushGraphicContext(DrawingWand *wand)
281</pre>
282
283<p>A description of each parameter follows:</p></ol>
284
285<h5>wand</h5>
286<ol><p>the drawing wand.</p></ol>
287
288 </div>
289<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
290_8c.html" target="source" name="DrawSetFillAlpha">DrawSetFillAlpha</a></h2>
291<div class="doc-section">
292
293<p>DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture. Fully opaque is 1.0.</p></ol>
294
295<p>The format of the DrawSetFillAlpha method is:</p>
296
297<pre class="code">
298 void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
299</pre>
300
301<p>A description of each parameter follows:</p></ol>
302
303<h5>wand</h5>
304<ol><p>the drawing wand.</p></ol>
305
306<h5>fill_alpha</h5>
307<ol><p>fill alpha</p></ol>
308
309 </div>
310<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
311_8c.html" target="source" name="DrawSetStrokeAlpha">DrawSetStrokeAlpha</a></h2>
312<div class="doc-section">
313
314<p>DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.</p></ol>
315
316<p>The format of the DrawSetStrokeAlpha method is:</p>
317
318<pre class="code">
319 void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
320</pre>
321
322<p>A description of each parameter follows:</p></ol>
323
324<h5>wand</h5>
325<ol><p>the drawing wand.</p></ol>
326
327<h5>stroke_alpha</h5>
328<ol><p>stroke alpha. The value 1.0 is opaque.</p></ol>
329
330 </div>
331<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
332_8c.html" target="source" name="MagickColorFloodfillImage">MagickColorFloodfillImage</a></h2>
333<div class="doc-section">
334
335<p>MagickColorFloodfillImage() 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>
336
337<p>The format of the MagickColorFloodfillImage method is:</p>
338
339<pre class="code">
340 MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
341 const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
342 const long x,const long y)
343</pre>
344
345<p>A description of each parameter follows:</p></ol>
346
347<h5>wand</h5>
348<ol><p>the magick wand.</p></ol>
349
350<h5>fill</h5>
351<ol><p>the floodfill color pixel wand.</p></ol>
352
353<h5>fuzz</h5>
354<ol><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>
355
356<h5>bordercolor</h5>
357<ol><p>the border color pixel wand.</p></ol>
358
359<h5>x,y</h5>
360<ol><p>the starting location of the operation.</p></ol>
361
362 </div>
363<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
364_8c.html" target="source" name="MagickDescribeImage">MagickDescribeImage</a></h2>
365<div class="doc-section">
366
367<p>MagickDescribeImage() identifies an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p></ol>
368
369<p>The format of the MagickDescribeImage method is:</p>
370
371<pre class="code">
372 const char *MagickDescribeImage(MagickWand *wand)
373</pre>
374
375<p>A description of each parameter follows:</p></ol>
376
377<h5>wand</h5>
378<ol><p>the magick wand.</p></ol>
379
380 </div>
381<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
382_8c.html" target="source" name="MagickFlattenImages">MagickFlattenImages</a></h2>
383<div class="doc-section">
384
385<p>MagickFlattenImages() merges a sequence of images. This useful for combining Photoshop layers into a single image.</p></ol>
386
387<p>The format of the MagickFlattenImages method is:</p>
388
389<pre class="code">
390 MagickWand *MagickFlattenImages(MagickWand *wand)
391</pre>
392
393<p>A description of each parameter follows:</p></ol>
394
395<h5>wand</h5>
396<ol><p>the magick wand.</p></ol>
397
398 </div>
399<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
400_8c.html" target="source" name="MagickGetImageAttribute">MagickGetImageAttribute</a></h2>
401<div class="doc-section">
402
403<p>MagickGetImageAttribute() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
404
405<p>The format of the MagickGetImageAttribute method is:</p>
406
407<pre class="code">
408 char *MagickGetImageAttribute(MagickWand *wand,const char *property)
409</pre>
410
411<p>A description of each parameter follows:</p></ol>
412
413<h5>wand</h5>
414<ol><p>the magick wand.</p></ol>
415
416<h5>property</h5>
417<ol><p>the property.</p></ol>
418
419 </div>
420<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
421_8c.html" target="source" name="MagickGetImageMatte">MagickGetImageMatte</a></h2>
422<div class="doc-section">
423
424<p>MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.</p></ol>
425
426<p>The format of the MagickGetImageMatte method is:</p>
427
428<pre class="code">
429 unsigned long MagickGetImageMatte(MagickWand *wand)
430</pre>
431
432<p>A description of each parameter follows:</p></ol>
433
434<h5>wand</h5>
435<ol><p>the magick wand.</p></ol>
436
437 </div>
438<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
439_8c.html" target="source" name="MagickGetImagePixels">MagickGetImagePixels</a></h2>
440<div class="doc-section">
441
442<p>MagickGetImagePixels() extracts pixel data from an image and returns it to you. The method returns MagickTrue on success otherwise MagickFalse 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>
443
444<p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
445
446<pre class="text">
447 MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
448</pre>
449
450<p>The format of the MagickGetImagePixels method is:</p>
451
452<pre class="code">
453 MagickBooleanType MagickGetImagePixels(MagickWand *wand,
454 const long x,const long y,const unsigned long columns,
455 const unsigned long rows,const char *map,const StorageType storage,
456 void *pixels)
457</pre>
458
459<p>A description of each parameter follows:</p></ol>
460
461<h5>wand</h5>
462<ol><p>the magick wand.</p></ol>
463
464<h5>x, y, columns, rows</h5>
465<ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
466
467<h5>map</h5>
468<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 (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.</p></ol>
469
470<h5>storage</h5>
471<ol><p>Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel, LongPixel, QuantumPixel, or ShortPixel.</p></ol>
472
473<h5>pixels</h5>
474<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>
475
476 </div>
477<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
478_8c.html" target="source" name="MagickGetImageSize">MagickGetImageSize</a></h2>
479<div class="doc-section">
480
481<p>MagickGetImageSize() returns the image length in bytes.</p></ol>
482
483<p>The format of the MagickGetImageSize method is:</p>
484
485<pre class="code">
486 MagickBooleanType MagickGetImageSize(MagickWand *wand,
487 MagickSizeType *length)
488</pre>
489
490<p>A description of each parameter follows:</p></ol>
491
492<h5>wand</h5>
493<ol><p>the magick wand.</p></ol>
494
495<h5>length</h5>
496<ol><p>the image length in bytes.</p></ol>
497
498 </div>
499<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
500_8c.html" target="source" name="MagickMapImage">MagickMapImage</a></h2>
501<div class="doc-section">
502
503<p>MagickMapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
504
505<p>The format of the MagickMapImage method is:</p>
506
507<pre class="code">
508 MagickBooleanType MagickMapImage(MagickWand *wand,
509 const MagickWand *map_wand,const MagickBooleanType dither)
510</pre>
511
512<p>A description of each parameter follows:</p></ol>
513
514<h5>wand</h5>
515<ol><p>the magick wand.</p></ol>
516
517<h5>map</h5>
518<ol><p>the map wand.</p></ol>
519
520<h5>dither</h5>
521<ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
522
523 </div>
524<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
525_8c.html" target="source" name="MagickMatteFloodfillImage">MagickMatteFloodfillImage</a></h2>
526<div class="doc-section">
527
528<p>MagickMatteFloodfillImage() 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>
529
530<p>The format of the MagickMatteFloodfillImage method is:</p>
531
532<pre class="code">
533 MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
534 const double alpha,const double fuzz,const PixelWand *bordercolor,
535 const long x,const long y)
536</pre>
537
538<p>A description of each parameter follows:</p></ol>
539
540<h5>wand</h5>
541<ol><p>the magick wand.</p></ol>
542
543<h5>alpha</h5>
544<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
545
546<h5>fuzz</h5>
547<ol><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>
548
549<h5>bordercolor</h5>
550<ol><p>the border color pixel wand.</p></ol>
551
552<h5>x,y</h5>
553<ol><p>the starting location of the operation.</p></ol>
554
555 </div>
556<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy63fed272010-03-07 19:08:45 +0000[diff] [blame]557_8c.html" target="source" name="MagickMaximumImages">MagickMaximumImages</a></h2>
558<div class="doc-section">
559
560<p>MagickMaximumImages() returns the maximum intensity of an image sequence.</p></ol>
561
562<p>The format of the MagickMaximumImages method is:</p>
563
564<pre class="code">
565 MagickWand *MagickMaximumImages(MagickWand *wand)
566</pre>
567
568<p>A description of each parameter follows:</p></ol>
569
570<h5>wand</h5>
571<ol><p>the magick wand.</p></ol>
572
573 </div>
574<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
575_8c.html" target="source" name="MagickMinimumImages">MagickMinimumImages</a></h2>
576<div class="doc-section">
577
578<p>MagickMinimumImages() returns the minimum intensity of an image sequence.</p></ol>
579
580<p>The format of the MagickMinimumImages method is:</p>
581
582<pre class="code">
583 MagickWand *MagickMinimumImages(MagickWand *wand)
584</pre>
585
586<p>A description of each parameter follows:</p></ol>
587
588<h5>wand</h5>
589<ol><p>the magick wand.</p></ol>
590
591 </div>
592<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]593_8c.html" target="source" name="MagickMosaicImages">MagickMosaicImages</a></h2>
594<div class="doc-section">
595
596<p>MagickMosaicImages() inlays an image sequence to form a single coherent picture. It returns a wand with each image in the sequence composited at the location defined by the page offset of the image.</p></ol>
597
598<p>The format of the MagickMosaicImages method is:</p>
599
600<pre class="code">
601 MagickWand *MagickMosaicImages(MagickWand *wand)
602</pre>
603
604<p>A description of each parameter follows:</p></ol>
605
606<h5>wand</h5>
607<ol><p>the magick wand.</p></ol>
608
609 </div>
610<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
611_8c.html" target="source" name="MagickOpaqueImage">MagickOpaqueImage</a></h2>
612<div class="doc-section">
613
614<p>MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
615
616<p>The format of the MagickOpaqueImage method is:</p>
617
618<pre class="code">
619 MagickBooleanType MagickOpaqueImage(MagickWand *wand,
620 const PixelWand *target,const PixelWand *fill,const double fuzz)
621</pre>
622
623<p>A description of each parameter follows:</p></ol>
624
625<h5>wand</h5>
626<ol><p>the magick wand.</p></ol>
627
628<h5>channel</h5>
629<ol><p>the channel(s).</p></ol>
630
631<h5>target</h5>
632<ol><p>Change this target color to the fill color within the image.</p></ol>
633
634<h5>fill</h5>
635<ol><p>the fill pixel wand.</p></ol>
636
637<h5>fuzz</h5>
638<ol><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>
639
640 </div>
641<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
642_8c.html" target="source" name="MagickPaintFloodfillImage">MagickPaintFloodfillImage</a></h2>
643<div class="doc-section">
644
645<p>MagickPaintFloodfillImage() 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>
646
647<p>The format of the MagickPaintFloodfillImage method is:</p>
648
649<pre class="code">
650 MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
651 const ChannelType channel,const PixelWand *fill,const double fuzz,
652 const PixelWand *bordercolor,const long x,const long y)
653</pre>
654
655<p>A description of each parameter follows:</p></ol>
656
657<h5>wand</h5>
658<ol><p>the magick wand.</p></ol>
659
660<h5>channel</h5>
661<ol><p>the channel(s).</p></ol>
662
663<h5>fill</h5>
664<ol><p>the floodfill color pixel wand.</p></ol>
665
666<h5>fuzz</h5>
667<ol><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>
668
669<h5>bordercolor</h5>
670<ol><p>the border color pixel wand.</p></ol>
671
672<h5>x,y</h5>
673<ol><p>the starting location of the operation.</p></ol>
674
675 </div>
676<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
677_8c.html" target="source" name="MagickPaintOpaqueImage">MagickPaintOpaqueImage</a></h2>
678<div class="doc-section">
679
680<p>MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
681
682<p>The format of the MagickPaintOpaqueImage method is:</p>
683
684<pre class="code">
685 MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
686 const PixelWand *target,const PixelWand *fill,const double fuzz)
687 MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
688 const ChannelType channel,const PixelWand *target,
689 const PixelWand *fill,const double fuzz)
690</pre>
691
692<p>A description of each parameter follows:</p></ol>
693
694<h5>wand</h5>
695<ol><p>the magick wand.</p></ol>
696
697<h5>channel</h5>
698<ol><p>the channel(s).</p></ol>
699
700<h5>target</h5>
701<ol><p>Change this target color to the fill color within the image.</p></ol>
702
703<h5>fill</h5>
704<ol><p>the fill pixel wand.</p></ol>
705
706<h5>fuzz</h5>
707<ol><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>
708
709 </div>
710<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
711_8c.html" target="source" name="MagickPaintTransparentImage">MagickPaintTransparentImage</a></h2>
712<div class="doc-section">
713
714<p>MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
715
716<p>The format of the MagickPaintTransparentImage method is:</p>
717
718<pre class="code">
719 MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
720 const PixelWand *target,const double alpha,const double fuzz)
721</pre>
722
723<p>A description of each parameter follows:</p></ol>
724
725<h5>wand</h5>
726<ol><p>the magick wand.</p></ol>
727
728<h5>target</h5>
729<ol><p>Change this target color to specified opacity value within the image.</p></ol>
730
731<h5>alpha</h5>
732<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
733
734<h5>fuzz</h5>
735<ol><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>
736
737 </div>
738<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame^]739_8c.html" target="source" name="MagickRecolorImage">MagickRecolorImage</a></h2>
740<div class="doc-section">
741
742<p>MagickRecolorImage() apply color transformation to an image. The method permits saturation changes, hue rotation, luminance to alpha, and various other effects. Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255).</p></ol>
743
744<p>The format of the MagickRecolorImage method is:</p>
745
746<pre class="code">
747 MagickBooleanType MagickRecolorImage(MagickWand *wand,
748 const unsigned long order,const double *color_matrix)
749</pre>
750
751<p>A description of each parameter follows:</p></ol>
752
753<h5>wand</h5>
754<ol><p>the magick wand.</p></ol>
755
756<h5>order</h5>
757<ol><p>the number of columns and rows in the color matrix.</p></ol>
758
759<h5>color_matrix</h5>
760<ol><p>An array of doubles representing the color matrix.</p></ol>
761
762 </div>
763<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]764_8c.html" target="source" name="MagickSetImageAttribute">MagickSetImageAttribute</a></h2>
765<div class="doc-section">
766
767<p>MagickSetImageAttribute() associates a property with an image.</p></ol>
768
769<p>The format of the MagickSetImageAttribute method is:</p>
770
771<pre class="code">
772 MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
773 const char *property,const char *value)
774</pre>
775
776<p>A description of each parameter follows:</p></ol>
777
778<h5>wand</h5>
779<ol><p>the magick wand.</p></ol>
780
781<h5>property</h5>
782<ol><p>the property.</p></ol>
783
784<h5>value</h5>
785<ol><p>the value.</p></ol>
786
787 </div>
788<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
789_8c.html" target="source" name="MagickSetImageIndex">MagickSetImageIndex</a></h2>
790<div class="doc-section">
791
792<p>MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.</p></ol>
793
794<p>The format of the MagickSetImageIndex method is:</p>
795
796<pre class="code">
797 MagickBooleanType MagickSetImageIndex(MagickWand *wand,const long index)
798</pre>
799
800<p>A description of each parameter follows:</p></ol>
801
802<h5>wand</h5>
803<ol><p>the magick wand.</p></ol>
804
805<h5>index</h5>
806<ol><p>the scene number.</p></ol>
807
808 </div>
809<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
810_8c.html" target="source" name="MagickTransparentImage">MagickTransparentImage</a></h2>
811<div class="doc-section">
812
813<p>MagickTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
814
815<p>The format of the MagickTransparentImage method is:</p>
816
817<pre class="code">
818 MagickBooleanType MagickTransparentImage(MagickWand *wand,
819 const PixelWand *target,const double alpha,const double fuzz)
820</pre>
821
822<p>A description of each parameter follows:</p></ol>
823
824<h5>wand</h5>
825<ol><p>the magick wand.</p></ol>
826
827<h5>target</h5>
828<ol><p>Change this target color to specified opacity value within the image.</p></ol>
829
830<h5>alpha</h5>
831<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
832
833<h5>fuzz</h5>
834<ol><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>
835
836 </div>
837<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
838_8c.html" target="source" name="MagickRegionOfInterestImage">MagickRegionOfInterestImage</a></h2>
839<div class="doc-section">
840
841<p>MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.</p></ol>
842
843<p>The format of the MagickRegionOfInterestImage method is:</p>
844
845<pre class="code">
846 MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
847 const unsigned long width,const unsigned long height,const long x,
848 const long y)
849</pre>
850
851<p>A description of each parameter follows:</p></ol>
852
853<h5>wand</h5>
854<ol><p>the magick wand.</p></ol>
855
856<h5>width</h5>
857<ol><p>the region width.</p></ol>
858
859<h5>height</h5>
860<ol><p>the region height.</p></ol>
861
862<h5>x</h5>
863<ol><p>the region x offset.</p></ol>
864
865<h5>y</h5>
866<ol><p>the region y offset.</p></ol>
867
868 </div>
869<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
870_8c.html" target="source" name="MagickSetImagePixels">MagickSetImagePixels</a></h2>
871<div class="doc-section">
872
873<p>MagickSetImagePixels() accepts pixel datand stores it in the image at the location you specify. The method returns MagickFalse on success otherwise MagickTrue if an error is encountered. The pixel data can be either char, short int, int, long, float, or double in the order specified by map.</p></ol>
874
875<p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
876
877<pre class="text">
878 MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
879</pre>
880
881<p>The format of the MagickSetImagePixels method is:</p>
882
883<pre class="code">
884 MagickBooleanType MagickSetImagePixels(MagickWand *wand,
885 const long x,const long y,const unsigned long columns,
886 const unsigned long rows,const char *map,const StorageType storage,
887 const void *pixels)
888</pre>
889
890<p>A description of each parameter follows:</p></ol>
891
892<h5>wand</h5>
893<ol><p>the magick wand.</p></ol>
894
895<h5>x, y, columns, rows</h5>
896<ol><p>These values define the perimeter of a region of pixels you want to define.</p></ol>
897
898<h5>map</h5>
899<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 (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.</p></ol>
900
901<h5>storage</h5>
902<ol><p>Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, ShortPixel, IntegerPixel, LongPixel, FloatPixel, or DoublePixel.</p></ol>
903
904<h5>pixels</h5>
905<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>
906
907 </div>
908<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
909_8c.html" target="source" name="MagickWriteImageBlob">MagickWriteImageBlob</a></h2>
910<div class="doc-section">
911
912<p>MagickWriteImageBlob() implements direct to memory image formats. It returns the image as a blob and its length. Use MagickSetFormat() to set the format of the returned blob (GIF, JPEG, PNG, etc.).</p></ol>
913
914<p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p></ol>
915
916<p>The format of the MagickWriteImageBlob method is:</p>
917
918<pre class="code">
919 unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
920</pre>
921
922<p>A description of each parameter follows:</p></ol>
923
924<h5>wand</h5>
925<ol><p>the magick wand.</p></ol>
926
927<h5>length</h5>
928<ol><p>the length of the blob.</p></ol>
929
930 </div>
931<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
932_8c.html" target="source" name="PixelGetNextRow">PixelGetNextRow</a></h2>
933<div class="doc-section">
934
935<p>PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
936
937<p>The format of the PixelGetNextRow method is:</p>
938
939<pre class="code">
940 PixelWand **PixelGetNextRow(PixelIterator *iterator,
941 unsigned long *number_wands)
942</pre>
943
944<p>A description of each parameter follows:</p></ol>
945
946<h5>iterator</h5>
947<ol><p>the pixel iterator.</p></ol>
948
949<h5>number_wands</h5>
950<ol><p>the number of pixel wands.</p></ol>
951
952 </div>
953<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
954_8c.html" target="source" name="PixelIteratorGetException">PixelIteratorGetException</a></h2>
955<div class="doc-section">
956
957<p>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
958
959<p>The format of the PixelIteratorGetException method is:</p>
960
961<pre class="code">
962 char *PixelIteratorGetException(const Pixeliterator *iterator,
963 ExceptionType *severity)
964</pre>
965
966<p>A description of each parameter follows:</p></ol>
967
968<h5>iterator</h5>
969<ol><p>the pixel iterator.</p></ol>
970
971<h5>severity</h5>
972<ol><p>the severity of the error is returned here.</p></ol>
973
974 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]975
976</div>
977
978<div id="linkbar">
979 <!-- <span id="linkbar-west">&nbsp;</span> -->
980 <span id="linkbar-center">
981 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristy0291e2d2010-04-04 17:50:18 +0000[diff] [blame^]982 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]983 </span>
984 <span id="linkbar-east">&nbsp;</span>
985 </div>
986 <div class="footer">
987 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
988 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
989 </div>
990 <div style="clear: both; margin: 0; width: 100%; "></div>
991</body>
992</html>