Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 0c72d809fc7a2e3910b33ecf116611a6dbe5014c / . / www / api / magick-deprecate.html
blob: 79be5dd953e8ea668be112faf55bd7c575aaba07 [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: 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"/>
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">
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]127 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
cristy5f2356f2009-11-16 00:40:46 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]130 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]133 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]136 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
137</div>
138<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]139 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
140</div>
141<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
143</div>
144<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
146</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
148</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]149
150
151</div>
152
153<div class="main">
154
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<p class="navigation-index">[<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="#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="#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>
156
157<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
158_8c.html" target="source" name="MagickClipPathImage">MagickClipPathImage</a></h2>
159<div class="doc-section">
160
161<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>
162
163<p>The format of the MagickClipPathImage method is:</p>
164
165<pre class="code">
166 MagickBooleanType MagickClipPathImage(MagickWand *wand,
167 const char *pathname,const MagickBooleanType inside)
168</pre>
169
170<p>A description of each parameter follows:</p></ol>
171
172<h5>wand</h5>
173<ol><p>the magick wand.</p></ol>
174
175<h5>pathname</h5>
176<ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
177
178<h5>inside</h5>
179<ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
180
181 </div>
182<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
183_8c.html" target="source" name="DrawGetFillAlpha">DrawGetFillAlpha</a></h2>
184<div class="doc-section">
185
186<p>DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture. Fully opaque is 1.0.</p></ol>
187
188<p>The format of the DrawGetFillAlpha method is:</p>
189
190<pre class="code">
191 double DrawGetFillAlpha(const DrawingWand *wand)
192</pre>
193
194<p>A description of each parameter follows:</p></ol>
195
196<h5>wand</h5>
197<ol><p>the drawing wand.</p></ol>
198
199 </div>
200<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
201_8c.html" target="source" name="DrawGetStrokeAlpha">DrawGetStrokeAlpha</a></h2>
202<div class="doc-section">
203
204<p>DrawGetStrokeAlpha() returns the alpha of stroked object outlines.</p></ol>
205
206<p>The format of the DrawGetStrokeAlpha method is:</p>
207
208<pre class="code">
209 double DrawGetStrokeAlpha(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>
216 </div>
217<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
218_8c.html" target="source" name="DrawPeekGraphicWand">DrawPeekGraphicWand</a></h2>
219<div class="doc-section">
220
221<p>DrawPeekGraphicWand() returns the current drawing wand.</p></ol>
222
223<p>The format of the PeekDrawingWand method is:</p>
224
225<pre class="code">
226 DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
227</pre>
228
229<p>A description of each parameter follows:</p></ol>
230
231<h5>wand</h5>
232<ol><p>the drawing wand.</p></ol>
233
234 </div>
235<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
236_8c.html" target="source" name="DrawPopGraphicContext">DrawPopGraphicContext</a></h2>
237<div class="doc-section">
238
239<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>
240
241<p>The format of the DrawPopGraphicContext method is:</p>
242
243<pre class="code">
244 MagickBooleanType DrawPopGraphicContext(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="DrawPushGraphicContext">DrawPushGraphicContext</a></h2>
255<div class="doc-section">
256
257<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>
258
259<p>The format of the DrawPushGraphicContext method is:</p>
260
261<pre class="code">
262 MagickBooleanType DrawPushGraphicContext(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="DrawSetFillAlpha">DrawSetFillAlpha</a></h2>
273<div class="doc-section">
274
275<p>DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture. Fully opaque is 1.0.</p></ol>
276
277<p>The format of the DrawSetFillAlpha method is:</p>
278
279<pre class="code">
280 void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
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<h5>fill_alpha</h5>
289<ol><p>fill alpha</p></ol>
290
291 </div>
292<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
293_8c.html" target="source" name="DrawSetStrokeAlpha">DrawSetStrokeAlpha</a></h2>
294<div class="doc-section">
295
296<p>DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.</p></ol>
297
298<p>The format of the DrawSetStrokeAlpha method is:</p>
299
300<pre class="code">
301 void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
302</pre>
303
304<p>A description of each parameter follows:</p></ol>
305
306<h5>wand</h5>
307<ol><p>the drawing wand.</p></ol>
308
309<h5>stroke_alpha</h5>
310<ol><p>stroke alpha. The value 1.0 is opaque.</p></ol>
311
312 </div>
313<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
314_8c.html" target="source" name="MagickColorFloodfillImage">MagickColorFloodfillImage</a></h2>
315<div class="doc-section">
316
317<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>
318
319<p>The format of the MagickColorFloodfillImage method is:</p>
320
321<pre class="code">
322 MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
323 const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
324 const long x,const long y)
325</pre>
326
327<p>A description of each parameter follows:</p></ol>
328
329<h5>wand</h5>
330<ol><p>the magick wand.</p></ol>
331
332<h5>fill</h5>
333<ol><p>the floodfill color pixel wand.</p></ol>
334
335<h5>fuzz</h5>
336<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>
337
338<h5>bordercolor</h5>
339<ol><p>the border color pixel wand.</p></ol>
340
341<h5>x,y</h5>
342<ol><p>the starting location of the operation.</p></ol>
343
344 </div>
345<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
346_8c.html" target="source" name="MagickDescribeImage">MagickDescribeImage</a></h2>
347<div class="doc-section">
348
349<p>MagickDescribeImage() identifies an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p></ol>
350
351<p>The format of the MagickDescribeImage method is:</p>
352
353<pre class="code">
354 const char *MagickDescribeImage(MagickWand *wand)
355</pre>
356
357<p>A description of each parameter follows:</p></ol>
358
359<h5>wand</h5>
360<ol><p>the magick wand.</p></ol>
361
362 </div>
363<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
364_8c.html" target="source" name="MagickFlattenImages">MagickFlattenImages</a></h2>
365<div class="doc-section">
366
367<p>MagickFlattenImages() merges a sequence of images. This useful for combining Photoshop layers into a single image.</p></ol>
368
369<p>The format of the MagickFlattenImages method is:</p>
370
371<pre class="code">
372 MagickWand *MagickFlattenImages(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="MagickGetImageAttribute">MagickGetImageAttribute</a></h2>
383<div class="doc-section">
384
385<p>MagickGetImageAttribute() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
386
387<p>The format of the MagickGetImageAttribute method is:</p>
388
389<pre class="code">
390 char *MagickGetImageAttribute(MagickWand *wand,const char *property)
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<h5>property</h5>
399<ol><p>the property.</p></ol>
400
401 </div>
402<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
403_8c.html" target="source" name="MagickGetImageMatte">MagickGetImageMatte</a></h2>
404<div class="doc-section">
405
406<p>MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.</p></ol>
407
408<p>The format of the MagickGetImageMatte method is:</p>
409
410<pre class="code">
411 unsigned long MagickGetImageMatte(MagickWand *wand)
412</pre>
413
414<p>A description of each parameter follows:</p></ol>
415
416<h5>wand</h5>
417<ol><p>the magick wand.</p></ol>
418
419 </div>
420<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
421_8c.html" target="source" name="MagickGetImagePixels">MagickGetImagePixels</a></h2>
422<div class="doc-section">
423
424<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>
425
426<p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
427
428<pre class="text">
429 MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
430</pre>
431
432<p>The format of the MagickGetImagePixels method is:</p>
433
434<pre class="code">
435 MagickBooleanType MagickGetImagePixels(MagickWand *wand,
436 const long x,const long y,const unsigned long columns,
437 const unsigned long rows,const char *map,const StorageType storage,
438 void *pixels)
439</pre>
440
441<p>A description of each parameter follows:</p></ol>
442
443<h5>wand</h5>
444<ol><p>the magick wand.</p></ol>
445
446<h5>x, y, columns, rows</h5>
447<ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
448
449<h5>map</h5>
450<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>
451
452<h5>storage</h5>
453<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>
454
455<h5>pixels</h5>
456<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>
457
458 </div>
459<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
460_8c.html" target="source" name="MagickGetImageSize">MagickGetImageSize</a></h2>
461<div class="doc-section">
462
463<p>MagickGetImageSize() returns the image length in bytes.</p></ol>
464
465<p>The format of the MagickGetImageSize method is:</p>
466
467<pre class="code">
468 MagickBooleanType MagickGetImageSize(MagickWand *wand,
469 MagickSizeType *length)
470</pre>
471
472<p>A description of each parameter follows:</p></ol>
473
474<h5>wand</h5>
475<ol><p>the magick wand.</p></ol>
476
477<h5>length</h5>
478<ol><p>the image length in bytes.</p></ol>
479
480 </div>
481<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
482_8c.html" target="source" name="MagickMapImage">MagickMapImage</a></h2>
483<div class="doc-section">
484
485<p>MagickMapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
486
487<p>The format of the MagickMapImage method is:</p>
488
489<pre class="code">
490 MagickBooleanType MagickMapImage(MagickWand *wand,
491 const MagickWand *map_wand,const MagickBooleanType dither)
492</pre>
493
494<p>A description of each parameter follows:</p></ol>
495
496<h5>wand</h5>
497<ol><p>the magick wand.</p></ol>
498
499<h5>map</h5>
500<ol><p>the map wand.</p></ol>
501
502<h5>dither</h5>
503<ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
504
505 </div>
506<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
507_8c.html" target="source" name="MagickMatteFloodfillImage">MagickMatteFloodfillImage</a></h2>
508<div class="doc-section">
509
510<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>
511
512<p>The format of the MagickMatteFloodfillImage method is:</p>
513
514<pre class="code">
515 MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
516 const double alpha,const double fuzz,const PixelWand *bordercolor,
517 const long x,const long y)
518</pre>
519
520<p>A description of each parameter follows:</p></ol>
521
522<h5>wand</h5>
523<ol><p>the magick wand.</p></ol>
524
525<h5>alpha</h5>
526<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
527
528<h5>fuzz</h5>
529<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>
530
531<h5>bordercolor</h5>
532<ol><p>the border color pixel wand.</p></ol>
533
534<h5>x,y</h5>
535<ol><p>the starting location of the operation.</p></ol>
536
537 </div>
538<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
539_8c.html" target="source" name="MagickMosaicImages">MagickMosaicImages</a></h2>
540<div class="doc-section">
541
542<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>
543
544<p>The format of the MagickMosaicImages method is:</p>
545
546<pre class="code">
547 MagickWand *MagickMosaicImages(MagickWand *wand)
548</pre>
549
550<p>A description of each parameter follows:</p></ol>
551
552<h5>wand</h5>
553<ol><p>the magick wand.</p></ol>
554
555 </div>
556<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
557_8c.html" target="source" name="MagickOpaqueImage">MagickOpaqueImage</a></h2>
558<div class="doc-section">
559
560<p>MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
561
562<p>The format of the MagickOpaqueImage method is:</p>
563
564<pre class="code">
565 MagickBooleanType MagickOpaqueImage(MagickWand *wand,
566 const PixelWand *target,const PixelWand *fill,const double fuzz)
567</pre>
568
569<p>A description of each parameter follows:</p></ol>
570
571<h5>wand</h5>
572<ol><p>the magick wand.</p></ol>
573
574<h5>channel</h5>
575<ol><p>the channel(s).</p></ol>
576
577<h5>target</h5>
578<ol><p>Change this target color to the fill color within the image.</p></ol>
579
580<h5>fill</h5>
581<ol><p>the fill pixel wand.</p></ol>
582
583<h5>fuzz</h5>
584<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>
585
586 </div>
587<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
588_8c.html" target="source" name="MagickPaintFloodfillImage">MagickPaintFloodfillImage</a></h2>
589<div class="doc-section">
590
591<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>
592
593<p>The format of the MagickPaintFloodfillImage method is:</p>
594
595<pre class="code">
596 MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
597 const ChannelType channel,const PixelWand *fill,const double fuzz,
598 const PixelWand *bordercolor,const long x,const long y)
599</pre>
600
601<p>A description of each parameter follows:</p></ol>
602
603<h5>wand</h5>
604<ol><p>the magick wand.</p></ol>
605
606<h5>channel</h5>
607<ol><p>the channel(s).</p></ol>
608
609<h5>fill</h5>
610<ol><p>the floodfill color pixel wand.</p></ol>
611
612<h5>fuzz</h5>
613<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>
614
615<h5>bordercolor</h5>
616<ol><p>the border color pixel wand.</p></ol>
617
618<h5>x,y</h5>
619<ol><p>the starting location of the operation.</p></ol>
620
621 </div>
622<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
623_8c.html" target="source" name="MagickPaintOpaqueImage">MagickPaintOpaqueImage</a></h2>
624<div class="doc-section">
625
626<p>MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
627
628<p>The format of the MagickPaintOpaqueImage method is:</p>
629
630<pre class="code">
631 MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
632 const PixelWand *target,const PixelWand *fill,const double fuzz)
633 MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
634 const ChannelType channel,const PixelWand *target,
635 const PixelWand *fill,const double fuzz)
636</pre>
637
638<p>A description of each parameter follows:</p></ol>
639
640<h5>wand</h5>
641<ol><p>the magick wand.</p></ol>
642
643<h5>channel</h5>
644<ol><p>the channel(s).</p></ol>
645
646<h5>target</h5>
647<ol><p>Change this target color to the fill color within the image.</p></ol>
648
649<h5>fill</h5>
650<ol><p>the fill pixel wand.</p></ol>
651
652<h5>fuzz</h5>
653<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>
654
655 </div>
656<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
657_8c.html" target="source" name="MagickPaintTransparentImage">MagickPaintTransparentImage</a></h2>
658<div class="doc-section">
659
660<p>MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
661
662<p>The format of the MagickPaintTransparentImage method is:</p>
663
664<pre class="code">
665 MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
666 const PixelWand *target,const double alpha,const double fuzz)
667</pre>
668
669<p>A description of each parameter follows:</p></ol>
670
671<h5>wand</h5>
672<ol><p>the magick wand.</p></ol>
673
674<h5>target</h5>
675<ol><p>Change this target color to specified opacity value within the image.</p></ol>
676
677<h5>alpha</h5>
678<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
679
680<h5>fuzz</h5>
681<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>
682
683 </div>
684<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
685_8c.html" target="source" name="MagickSetImageAttribute">MagickSetImageAttribute</a></h2>
686<div class="doc-section">
687
688<p>MagickSetImageAttribute() associates a property with an image.</p></ol>
689
690<p>The format of the MagickSetImageAttribute method is:</p>
691
692<pre class="code">
693 MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
694 const char *property,const char *value)
695</pre>
696
697<p>A description of each parameter follows:</p></ol>
698
699<h5>wand</h5>
700<ol><p>the magick wand.</p></ol>
701
702<h5>property</h5>
703<ol><p>the property.</p></ol>
704
705<h5>value</h5>
706<ol><p>the value.</p></ol>
707
708 </div>
709<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
710_8c.html" target="source" name="MagickSetImageIndex">MagickSetImageIndex</a></h2>
711<div class="doc-section">
712
713<p>MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.</p></ol>
714
715<p>The format of the MagickSetImageIndex method is:</p>
716
717<pre class="code">
718 MagickBooleanType MagickSetImageIndex(MagickWand *wand,const long index)
719</pre>
720
721<p>A description of each parameter follows:</p></ol>
722
723<h5>wand</h5>
724<ol><p>the magick wand.</p></ol>
725
726<h5>index</h5>
727<ol><p>the scene number.</p></ol>
728
729 </div>
730<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
731_8c.html" target="source" name="MagickTransparentImage">MagickTransparentImage</a></h2>
732<div class="doc-section">
733
734<p>MagickTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
735
736<p>The format of the MagickTransparentImage method is:</p>
737
738<pre class="code">
739 MagickBooleanType MagickTransparentImage(MagickWand *wand,
740 const PixelWand *target,const double alpha,const double fuzz)
741</pre>
742
743<p>A description of each parameter follows:</p></ol>
744
745<h5>wand</h5>
746<ol><p>the magick wand.</p></ol>
747
748<h5>target</h5>
749<ol><p>Change this target color to specified opacity value within the image.</p></ol>
750
751<h5>alpha</h5>
752<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
753
754<h5>fuzz</h5>
755<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>
756
757 </div>
758<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
759_8c.html" target="source" name="MagickRegionOfInterestImage">MagickRegionOfInterestImage</a></h2>
760<div class="doc-section">
761
762<p>MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.</p></ol>
763
764<p>The format of the MagickRegionOfInterestImage method is:</p>
765
766<pre class="code">
767 MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
768 const unsigned long width,const unsigned long height,const long x,
769 const long y)
770</pre>
771
772<p>A description of each parameter follows:</p></ol>
773
774<h5>wand</h5>
775<ol><p>the magick wand.</p></ol>
776
777<h5>width</h5>
778<ol><p>the region width.</p></ol>
779
780<h5>height</h5>
781<ol><p>the region height.</p></ol>
782
783<h5>x</h5>
784<ol><p>the region x offset.</p></ol>
785
786<h5>y</h5>
787<ol><p>the region y offset.</p></ol>
788
789 </div>
790<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
791_8c.html" target="source" name="MagickSetImagePixels">MagickSetImagePixels</a></h2>
792<div class="doc-section">
793
794<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>
795
796<p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
797
798<pre class="text">
799 MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
800</pre>
801
802<p>The format of the MagickSetImagePixels method is:</p>
803
804<pre class="code">
805 MagickBooleanType MagickSetImagePixels(MagickWand *wand,
806 const long x,const long y,const unsigned long columns,
807 const unsigned long rows,const char *map,const StorageType storage,
808 const void *pixels)
809</pre>
810
811<p>A description of each parameter follows:</p></ol>
812
813<h5>wand</h5>
814<ol><p>the magick wand.</p></ol>
815
816<h5>x, y, columns, rows</h5>
817<ol><p>These values define the perimeter of a region of pixels you want to define.</p></ol>
818
819<h5>map</h5>
820<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>
821
822<h5>storage</h5>
823<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>
824
825<h5>pixels</h5>
826<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>
827
828 </div>
829<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
830_8c.html" target="source" name="MagickWriteImageBlob">MagickWriteImageBlob</a></h2>
831<div class="doc-section">
832
833<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>
834
835<p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p></ol>
836
837<p>The format of the MagickWriteImageBlob method is:</p>
838
839<pre class="code">
840 unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
841</pre>
842
843<p>A description of each parameter follows:</p></ol>
844
845<h5>wand</h5>
846<ol><p>the magick wand.</p></ol>
847
848<h5>length</h5>
849<ol><p>the length of the blob.</p></ol>
850
851 </div>
852<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
853_8c.html" target="source" name="PixelGetNextRow">PixelGetNextRow</a></h2>
854<div class="doc-section">
855
856<p>PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
857
858<p>The format of the PixelGetNextRow method is:</p>
859
860<pre class="code">
861 PixelWand **PixelGetNextRow(PixelIterator *iterator,
862 unsigned long *number_wands)
863</pre>
864
865<p>A description of each parameter follows:</p></ol>
866
867<h5>iterator</h5>
868<ol><p>the pixel iterator.</p></ol>
869
870<h5>number_wands</h5>
871<ol><p>the number of pixel wands.</p></ol>
872
873 </div>
874<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
875_8c.html" target="source" name="PixelIteratorGetException">PixelIteratorGetException</a></h2>
876<div class="doc-section">
877
878<p>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
879
880<p>The format of the PixelIteratorGetException method is:</p>
881
882<pre class="code">
883 char *PixelIteratorGetException(const Pixeliterator *iterator,
884 ExceptionType *severity)
885</pre>
886
887<p>A description of each parameter follows:</p></ol>
888
889<h5>iterator</h5>
890<ol><p>the pixel iterator.</p></ol>
891
892<h5>severity</h5>
893<ol><p>the severity of the error is returned here.</p></ol>
894
895 </div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]896
897</div>
898
899<div id="linkbar">
900 <!-- <span id="linkbar-west">&nbsp;</span> -->
901 <span id="linkbar-center">
902 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
903 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
cristy0c72d802009-12-28 13:48:31 +0000[diff] [blame^]904 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]905 </span>
906 <span id="linkbar-east">&nbsp;</span>
907 </div>
908 <div class="footer">
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]909 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]910 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
911 </div>
912 <div style="clear: both; margin: 0; width: 100%; "></div>
913</body>
914</html>