blob: 56c4f8aa929807b403fd3a7529b3272e31795159 [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
7 <style type="text/css" media="screen,projection"><!--
8 @import url("../../www/magick.css");
9 --></style>
10 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
11 <title>ImageMagick: MagickWand, C API for ImageMagick: Deprecated Methods</title>
12 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
15 <meta name="Generator" content="PHP"/>
16 <meta name="Keywords" content="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"/>
17 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
18 <meta name="Rating" content="GENERAL"/>
19 <meta name="Robots" content="INDEX, FOLLOW"/>
20 <meta name="Generator" content="ImageMagick Studio LLC"/>
21 <meta name="Author" content="ImageMagick Studio LLC"/>
22 <meta name="Revisit-after" content="2 DAYS"/>
23 <meta name="Resource-type" content="document"/>
24 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
25 <meta name="Distribution" content="Global"/>
26</head>
27
28<body id="www-imagemagick-org">
29<div class="titlebar">
30<a href="../../index.html">
31 <img src="../../images/script.png" alt="[ImageMagick]"
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
33<a href="http://www.networkredux.com">
34 <img src="../../images/networkredux.png" alt="[sponsor]"
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
36<a href="http://www.imagemagick.org/discourse-server/">
37 <img src="../../images/logo.jpg" alt=""
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
39<a href="../../index.html">
40 <img src="../../images/sprite.jpg" alt=""
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
42</div>
43
44<div class="eastbar">
45
46<div class="menu">
47 <a href="../../index.html">About ImageMagick</a>
48</div>
49<div class="sep"></div>
50<div class="menu">
51 <a href="../../www/command-line-tools.html">Command-line Tools</a>
52</div>
53<div class="sub">
54 <a href="../../www/command-line-processing.html">Processing</a>
55</div>
56<div class="sub">
57 <a href="../../www/command-line-options.html">Options</a>
58</div>
59<div class="sub">
60 <a href="http://www.imagemagick.org/Usage/">Usage</a>
61</div>
62<div class="menu">
63 <a href="../../www/api.html">Program Interfaces</a>
64</div>
65<div class="sub">
66 <a href="../../www/magick-wand.html">MagickWand</a>
67</div>
68<div class="sub">
69 <a href="../../www/magick-core.html">MagickCore</a>
70</div>
71<div class="sub">
72 <a href="../../www/perl-magick.html">PerlMagick</a>
73</div>
74<div class="sub">
75 <a href="../../Magick++/">Magick++</a>
76</div>
77<div class="menu">
78 <a href="../../www/architecture.html">Architecture</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
82 <a href="../../www/install-source.html">Install from Source</a>
83</div>
84<div class="sub">
85 <a href="../../www/install-source.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a href="../../www/install-source.html#windows">Windows</a>
89 </div>
90<div class="menu">
91 <a href="../../www/binary-releases.html">Binary Releases</a>
92</div>
93<div class="sub">
94 <a href="../../www/binary-releases.html#unix">Unix</a>
95</div>
96<div class="sub">
97 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
98</div>
99<div class="sub">
100 <a href="../../www/binary-releases.html#windows">Windows</a>
101</div>
102<div class="menu">
103 <a href="../../www/resources.html">Resources</a>
104</div>
105<div class="sep"></div>
106<div class="menu">
107 <a href="../../www/download.html">Download</a>
108</div>
109<div class="sep"></div>
110<div class="menu">
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112</div>
113<div class="sep"></div>
114<div class="menu">
115 <a href="../../www/sitemap.html">Site Map</a>
116</div>
117<div class="sub">
118 <a href="../../www/links.html">Links</a>
119</div>
120<div class="sep"></div>
121<div class="menu">
122 <a href="../../www/sponsors.html">Sponsors:</a>
123
124<div class="sponsbox">
125<div class="sponsor">
126 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
127</div>
128<div class="sponsor">
129 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
130</div>
131<div class="sponsor">
132 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
133</div>
134<div class="sponsor">
135 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
136</div>
137<div class="sponsor">
138 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
139</div>
140</div>
141</div>
142
143
144</div>
145
146<div class="main">
147
148<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>
149
150<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
151_8c.html" target="source" name="MagickClipPathImage">MagickClipPathImage</a></h2>
152<div class="doc-section">
153
154<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>
155
156<p>The format of the MagickClipPathImage method is:</p>
157
158<pre class="code">
159 MagickBooleanType MagickClipPathImage(MagickWand *wand,
160 const char *pathname,const MagickBooleanType inside)
161</pre>
162
163<p>A description of each parameter follows:</p></ol>
164
165<h5>wand</h5>
166<ol><p>the magick wand.</p></ol>
167
168<h5>pathname</h5>
169<ol><p>name of clipping path resource. If name is preceded by #, use clipping path numbered by name.</p></ol>
170
171<h5>inside</h5>
172<ol><p>if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.</p></ol>
173
174 </div>
175<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
176_8c.html" target="source" name="DrawGetFillAlpha">DrawGetFillAlpha</a></h2>
177<div class="doc-section">
178
179<p>DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture. Fully opaque is 1.0.</p></ol>
180
181<p>The format of the DrawGetFillAlpha method is:</p>
182
183<pre class="code">
184 double DrawGetFillAlpha(const DrawingWand *wand)
185</pre>
186
187<p>A description of each parameter follows:</p></ol>
188
189<h5>wand</h5>
190<ol><p>the drawing wand.</p></ol>
191
192 </div>
193<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
194_8c.html" target="source" name="DrawGetStrokeAlpha">DrawGetStrokeAlpha</a></h2>
195<div class="doc-section">
196
197<p>DrawGetStrokeAlpha() returns the alpha of stroked object outlines.</p></ol>
198
199<p>The format of the DrawGetStrokeAlpha method is:</p>
200
201<pre class="code">
202 double DrawGetStrokeAlpha(const DrawingWand *wand)
203</pre>
204
205<p>A description of each parameter follows:</p></ol>
206
207<h5>wand</h5>
208<ol><p>the drawing wand. </p>
209 </div>
210<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
211_8c.html" target="source" name="DrawPeekGraphicWand">DrawPeekGraphicWand</a></h2>
212<div class="doc-section">
213
214<p>DrawPeekGraphicWand() returns the current drawing wand.</p></ol>
215
216<p>The format of the PeekDrawingWand method is:</p>
217
218<pre class="code">
219 DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
220</pre>
221
222<p>A description of each parameter follows:</p></ol>
223
224<h5>wand</h5>
225<ol><p>the drawing wand.</p></ol>
226
227 </div>
228<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
229_8c.html" target="source" name="DrawPopGraphicContext">DrawPopGraphicContext</a></h2>
230<div class="doc-section">
231
232<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>
233
234<p>The format of the DrawPopGraphicContext method is:</p>
235
236<pre class="code">
237 MagickBooleanType DrawPopGraphicContext(DrawingWand *wand)
238</pre>
239
240<p>A description of each parameter follows:</p></ol>
241
242<h5>wand</h5>
243<ol><p>the drawing wand.</p></ol>
244
245 </div>
246<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
247_8c.html" target="source" name="DrawPushGraphicContext">DrawPushGraphicContext</a></h2>
248<div class="doc-section">
249
250<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>
251
252<p>The format of the DrawPushGraphicContext method is:</p>
253
254<pre class="code">
255 MagickBooleanType DrawPushGraphicContext(DrawingWand *wand)
256</pre>
257
258<p>A description of each parameter follows:</p></ol>
259
260<h5>wand</h5>
261<ol><p>the drawing wand.</p></ol>
262
263 </div>
264<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
265_8c.html" target="source" name="DrawSetFillAlpha">DrawSetFillAlpha</a></h2>
266<div class="doc-section">
267
268<p>DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture. Fully opaque is 1.0.</p></ol>
269
270<p>The format of the DrawSetFillAlpha method is:</p>
271
272<pre class="code">
273 void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
274</pre>
275
276<p>A description of each parameter follows:</p></ol>
277
278<h5>wand</h5>
279<ol><p>the drawing wand.</p></ol>
280
281<h5>fill_alpha</h5>
282<ol><p>fill alpha</p></ol>
283
284 </div>
285<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
286_8c.html" target="source" name="DrawSetStrokeAlpha">DrawSetStrokeAlpha</a></h2>
287<div class="doc-section">
288
289<p>DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.</p></ol>
290
291<p>The format of the DrawSetStrokeAlpha method is:</p>
292
293<pre class="code">
294 void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
295</pre>
296
297<p>A description of each parameter follows:</p></ol>
298
299<h5>wand</h5>
300<ol><p>the drawing wand.</p></ol>
301
302<h5>stroke_alpha</h5>
303<ol><p>stroke alpha. The value 1.0 is opaque.</p></ol>
304
305 </div>
306<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
307_8c.html" target="source" name="MagickColorFloodfillImage">MagickColorFloodfillImage</a></h2>
308<div class="doc-section">
309
310<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>
311
312<p>The format of the MagickColorFloodfillImage method is:</p>
313
314<pre class="code">
315 MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
316 const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
317 const long x,const long y)
318</pre>
319
320<p>A description of each parameter follows:</p></ol>
321
322<h5>wand</h5>
323<ol><p>the magick wand.</p></ol>
324
325<h5>fill</h5>
326<ol><p>the floodfill color pixel wand.</p></ol>
327
328<h5>fuzz</h5>
329<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>
330
331<h5>bordercolor</h5>
332<ol><p>the border color pixel wand.</p></ol>
333
334<h5>x,y</h5>
335<ol><p>the starting location of the operation.</p></ol>
336
337 </div>
338<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
339_8c.html" target="source" name="MagickDescribeImage">MagickDescribeImage</a></h2>
340<div class="doc-section">
341
342<p>MagickDescribeImage() identifies an image by printing its attributes to the file. Attributes include the image width, height, size, and others.</p></ol>
343
344<p>The format of the MagickDescribeImage method is:</p>
345
346<pre class="code">
347 const char *MagickDescribeImage(MagickWand *wand)
348</pre>
349
350<p>A description of each parameter follows:</p></ol>
351
352<h5>wand</h5>
353<ol><p>the magick wand.</p></ol>
354
355 </div>
356<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
357_8c.html" target="source" name="MagickFlattenImages">MagickFlattenImages</a></h2>
358<div class="doc-section">
359
360<p>MagickFlattenImages() merges a sequence of images. This useful for combining Photoshop layers into a single image.</p></ol>
361
362<p>The format of the MagickFlattenImages method is:</p>
363
364<pre class="code">
365 MagickWand *MagickFlattenImages(MagickWand *wand)
366</pre>
367
368<p>A description of each parameter follows:</p></ol>
369
370<h5>wand</h5>
371<ol><p>the magick wand.</p></ol>
372
373 </div>
374<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
375_8c.html" target="source" name="MagickGetImageAttribute">MagickGetImageAttribute</a></h2>
376<div class="doc-section">
377
378<p>MagickGetImageAttribute() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p></ol>
379
380<p>The format of the MagickGetImageAttribute method is:</p>
381
382<pre class="code">
383 char *MagickGetImageAttribute(MagickWand *wand,const char *property)
384</pre>
385
386<p>A description of each parameter follows:</p></ol>
387
388<h5>wand</h5>
389<ol><p>the magick wand.</p></ol>
390
391<h5>property</h5>
392<ol><p>the property.</p></ol>
393
394 </div>
395<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
396_8c.html" target="source" name="MagickGetImageMatte">MagickGetImageMatte</a></h2>
397<div class="doc-section">
398
399<p>MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.</p></ol>
400
401<p>The format of the MagickGetImageMatte method is:</p>
402
403<pre class="code">
404 unsigned long MagickGetImageMatte(MagickWand *wand)
405</pre>
406
407<p>A description of each parameter follows:</p></ol>
408
409<h5>wand</h5>
410<ol><p>the magick wand.</p></ol>
411
412 </div>
413<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
414_8c.html" target="source" name="MagickGetImagePixels">MagickGetImagePixels</a></h2>
415<div class="doc-section">
416
417<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>
418
419<p>Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:</p>
420
421<pre class="text">
422 MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
423</pre>
424
425<p>The format of the MagickGetImagePixels method is:</p>
426
427<pre class="code">
428 MagickBooleanType MagickGetImagePixels(MagickWand *wand,
429 const long x,const long y,const unsigned long columns,
430 const unsigned long rows,const char *map,const StorageType storage,
431 void *pixels)
432</pre>
433
434<p>A description of each parameter follows:</p></ol>
435
436<h5>wand</h5>
437<ol><p>the magick wand.</p></ol>
438
439<h5>x, y, columns, rows</h5>
440<ol><p>These values define the perimeter of a region of pixels you want to extract.</p></ol>
441
442<h5>map</h5>
443<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>
444
445<h5>storage</h5>
446<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>
447
448<h5>pixels</h5>
449<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>
450
451 </div>
452<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
453_8c.html" target="source" name="MagickGetImageSize">MagickGetImageSize</a></h2>
454<div class="doc-section">
455
456<p>MagickGetImageSize() returns the image length in bytes.</p></ol>
457
458<p>The format of the MagickGetImageSize method is:</p>
459
460<pre class="code">
461 MagickBooleanType MagickGetImageSize(MagickWand *wand,
462 MagickSizeType *length)
463</pre>
464
465<p>A description of each parameter follows:</p></ol>
466
467<h5>wand</h5>
468<ol><p>the magick wand.</p></ol>
469
470<h5>length</h5>
471<ol><p>the image length in bytes.</p></ol>
472
473 </div>
474<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
475_8c.html" target="source" name="MagickMapImage">MagickMapImage</a></h2>
476<div class="doc-section">
477
478<p>MagickMapImage() replaces the colors of an image with the closest color from a reference image.</p></ol>
479
480<p>The format of the MagickMapImage method is:</p>
481
482<pre class="code">
483 MagickBooleanType MagickMapImage(MagickWand *wand,
484 const MagickWand *map_wand,const MagickBooleanType dither)
485</pre>
486
487<p>A description of each parameter follows:</p></ol>
488
489<h5>wand</h5>
490<ol><p>the magick wand.</p></ol>
491
492<h5>map</h5>
493<ol><p>the map wand.</p></ol>
494
495<h5>dither</h5>
496<ol><p>Set this integer value to something other than zero to dither the mapped image.</p></ol>
497
498 </div>
499<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
500_8c.html" target="source" name="MagickMatteFloodfillImage">MagickMatteFloodfillImage</a></h2>
501<div class="doc-section">
502
503<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>
504
505<p>The format of the MagickMatteFloodfillImage method is:</p>
506
507<pre class="code">
508 MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
509 const double alpha,const double fuzz,const PixelWand *bordercolor,
510 const long x,const long y)
511</pre>
512
513<p>A description of each parameter follows:</p></ol>
514
515<h5>wand</h5>
516<ol><p>the magick wand.</p></ol>
517
518<h5>alpha</h5>
519<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
520
521<h5>fuzz</h5>
522<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>
523
524<h5>bordercolor</h5>
525<ol><p>the border color pixel wand.</p></ol>
526
527<h5>x,y</h5>
528<ol><p>the starting location of the operation.</p></ol>
529
530 </div>
531<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
532_8c.html" target="source" name="MagickMosaicImages">MagickMosaicImages</a></h2>
533<div class="doc-section">
534
535<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>
536
537<p>The format of the MagickMosaicImages method is:</p>
538
539<pre class="code">
540 MagickWand *MagickMosaicImages(MagickWand *wand)
541</pre>
542
543<p>A description of each parameter follows:</p></ol>
544
545<h5>wand</h5>
546<ol><p>the magick wand.</p></ol>
547
548 </div>
549<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
550_8c.html" target="source" name="MagickOpaqueImage">MagickOpaqueImage</a></h2>
551<div class="doc-section">
552
553<p>MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
554
555<p>The format of the MagickOpaqueImage method is:</p>
556
557<pre class="code">
558 MagickBooleanType MagickOpaqueImage(MagickWand *wand,
559 const PixelWand *target,const PixelWand *fill,const double fuzz)
560</pre>
561
562<p>A description of each parameter follows:</p></ol>
563
564<h5>wand</h5>
565<ol><p>the magick wand.</p></ol>
566
567<h5>channel</h5>
568<ol><p>the channel(s).</p></ol>
569
570<h5>target</h5>
571<ol><p>Change this target color to the fill color within the image.</p></ol>
572
573<h5>fill</h5>
574<ol><p>the fill pixel wand.</p></ol>
575
576<h5>fuzz</h5>
577<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>
578
579 </div>
580<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
581_8c.html" target="source" name="MagickPaintFloodfillImage">MagickPaintFloodfillImage</a></h2>
582<div class="doc-section">
583
584<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>
585
586<p>The format of the MagickPaintFloodfillImage method is:</p>
587
588<pre class="code">
589 MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
590 const ChannelType channel,const PixelWand *fill,const double fuzz,
591 const PixelWand *bordercolor,const long x,const long y)
592</pre>
593
594<p>A description of each parameter follows:</p></ol>
595
596<h5>wand</h5>
597<ol><p>the magick wand.</p></ol>
598
599<h5>channel</h5>
600<ol><p>the channel(s).</p></ol>
601
602<h5>fill</h5>
603<ol><p>the floodfill color pixel wand.</p></ol>
604
605<h5>fuzz</h5>
606<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>
607
608<h5>bordercolor</h5>
609<ol><p>the border color pixel wand.</p></ol>
610
611<h5>x,y</h5>
612<ol><p>the starting location of the operation.</p></ol>
613
614 </div>
615<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
616_8c.html" target="source" name="MagickPaintOpaqueImage">MagickPaintOpaqueImage</a></h2>
617<div class="doc-section">
618
619<p>MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.</p></ol>
620
621<p>The format of the MagickPaintOpaqueImage method is:</p>
622
623<pre class="code">
624 MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
625 const PixelWand *target,const PixelWand *fill,const double fuzz)
626 MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
627 const ChannelType channel,const PixelWand *target,
628 const PixelWand *fill,const double fuzz)
629</pre>
630
631<p>A description of each parameter follows:</p></ol>
632
633<h5>wand</h5>
634<ol><p>the magick wand.</p></ol>
635
636<h5>channel</h5>
637<ol><p>the channel(s).</p></ol>
638
639<h5>target</h5>
640<ol><p>Change this target color to the fill color within the image.</p></ol>
641
642<h5>fill</h5>
643<ol><p>the fill pixel wand.</p></ol>
644
645<h5>fuzz</h5>
646<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>
647
648 </div>
649<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
650_8c.html" target="source" name="MagickPaintTransparentImage">MagickPaintTransparentImage</a></h2>
651<div class="doc-section">
652
653<p>MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
654
655<p>The format of the MagickPaintTransparentImage method is:</p>
656
657<pre class="code">
658 MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
659 const PixelWand *target,const double alpha,const double fuzz)
660</pre>
661
662<p>A description of each parameter follows:</p></ol>
663
664<h5>wand</h5>
665<ol><p>the magick wand.</p></ol>
666
667<h5>target</h5>
668<ol><p>Change this target color to specified opacity value within the image.</p></ol>
669
670<h5>alpha</h5>
671<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
672
673<h5>fuzz</h5>
674<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>
675
676 </div>
677<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
678_8c.html" target="source" name="MagickSetImageAttribute">MagickSetImageAttribute</a></h2>
679<div class="doc-section">
680
681<p>MagickSetImageAttribute() associates a property with an image.</p></ol>
682
683<p>The format of the MagickSetImageAttribute method is:</p>
684
685<pre class="code">
686 MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
687 const char *property,const char *value)
688</pre>
689
690<p>A description of each parameter follows:</p></ol>
691
692<h5>wand</h5>
693<ol><p>the magick wand.</p></ol>
694
695<h5>property</h5>
696<ol><p>the property.</p></ol>
697
698<h5>value</h5>
699<ol><p>the value.</p></ol>
700
701 </div>
702<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
703_8c.html" target="source" name="MagickSetImageIndex">MagickSetImageIndex</a></h2>
704<div class="doc-section">
705
706<p>MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.</p></ol>
707
708<p>The format of the MagickSetImageIndex method is:</p>
709
710<pre class="code">
711 MagickBooleanType MagickSetImageIndex(MagickWand *wand,const long index)
712</pre>
713
714<p>A description of each parameter follows:</p></ol>
715
716<h5>wand</h5>
717<ol><p>the magick wand.</p></ol>
718
719<h5>index</h5>
720<ol><p>the scene number.</p></ol>
721
722 </div>
723<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
724_8c.html" target="source" name="MagickTransparentImage">MagickTransparentImage</a></h2>
725<div class="doc-section">
726
727<p>MagickTransparentImage() changes any pixel that matches color with the color defined by fill.</p></ol>
728
729<p>The format of the MagickTransparentImage method is:</p>
730
731<pre class="code">
732 MagickBooleanType MagickTransparentImage(MagickWand *wand,
733 const PixelWand *target,const double alpha,const double fuzz)
734</pre>
735
736<p>A description of each parameter follows:</p></ol>
737
738<h5>wand</h5>
739<ol><p>the magick wand.</p></ol>
740
741<h5>target</h5>
742<ol><p>Change this target color to specified opacity value within the image.</p></ol>
743
744<h5>alpha</h5>
745<ol><p>the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.</p></ol>
746
747<h5>fuzz</h5>
748<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>
749
750 </div>
751<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
752_8c.html" target="source" name="MagickRegionOfInterestImage">MagickRegionOfInterestImage</a></h2>
753<div class="doc-section">
754
755<p>MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.</p></ol>
756
757<p>The format of the MagickRegionOfInterestImage method is:</p>
758
759<pre class="code">
760 MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
761 const unsigned long width,const unsigned long height,const long x,
762 const long y)
763</pre>
764
765<p>A description of each parameter follows:</p></ol>
766
767<h5>wand</h5>
768<ol><p>the magick wand.</p></ol>
769
770<h5>width</h5>
771<ol><p>the region width.</p></ol>
772
773<h5>height</h5>
774<ol><p>the region height.</p></ol>
775
776<h5>x</h5>
777<ol><p>the region x offset.</p></ol>
778
779<h5>y</h5>
780<ol><p>the region y offset.</p></ol>
781
782 </div>
783<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
784_8c.html" target="source" name="MagickSetImagePixels">MagickSetImagePixels</a></h2>
785<div class="doc-section">
786
787<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>
788
789<p>Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:</p>
790
791<pre class="text">
792 MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
793</pre>
794
795<p>The format of the MagickSetImagePixels method is:</p>
796
797<pre class="code">
798 MagickBooleanType MagickSetImagePixels(MagickWand *wand,
799 const long x,const long y,const unsigned long columns,
800 const unsigned long rows,const char *map,const StorageType storage,
801 const void *pixels)
802</pre>
803
804<p>A description of each parameter follows:</p></ol>
805
806<h5>wand</h5>
807<ol><p>the magick wand.</p></ol>
808
809<h5>x, y, columns, rows</h5>
810<ol><p>These values define the perimeter of a region of pixels you want to define.</p></ol>
811
812<h5>map</h5>
813<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>
814
815<h5>storage</h5>
816<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>
817
818<h5>pixels</h5>
819<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>
820
821 </div>
822<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
823_8c.html" target="source" name="MagickWriteImageBlob">MagickWriteImageBlob</a></h2>
824<div class="doc-section">
825
826<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>
827
828<p>Use MagickRelinquishMemory() to free the blob when you are done with it.</p></ol>
829
830<p>The format of the MagickWriteImageBlob method is:</p>
831
832<pre class="code">
833 unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
834</pre>
835
836<p>A description of each parameter follows:</p></ol>
837
838<h5>wand</h5>
839<ol><p>the magick wand.</p></ol>
840
841<h5>length</h5>
842<ol><p>the length of the blob.</p></ol>
843
844 </div>
845<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
846_8c.html" target="source" name="PixelGetNextRow">PixelGetNextRow</a></h2>
847<div class="doc-section">
848
849<p>PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
850
851<p>The format of the PixelGetNextRow method is:</p>
852
853<pre class="code">
854 PixelWand **PixelGetNextRow(PixelIterator *iterator,
855 unsigned long *number_wands)
856</pre>
857
858<p>A description of each parameter follows:</p></ol>
859
860<h5>iterator</h5>
861<ol><p>the pixel iterator.</p></ol>
862
863<h5>number_wands</h5>
864<ol><p>the number of pixel wands.</p></ol>
865
866 </div>
867<h2><a href="http://www.imagemagick.org/api/MagickWand/deprecate
868_8c.html" target="source" name="PixelIteratorGetException">PixelIteratorGetException</a></h2>
869<div class="doc-section">
870
871<p>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
872
873<p>The format of the PixelIteratorGetException method is:</p>
874
875<pre class="code">
876 char *PixelIteratorGetException(const Pixeliterator *iterator,
877 ExceptionType *severity)
878</pre>
879
880<p>A description of each parameter follows:</p></ol>
881
882<h5>iterator</h5>
883<ol><p>the pixel iterator.</p></ol>
884
885<h5>severity</h5>
886<ol><p>the severity of the error is returned here.</p></ol>
887
888 </div>
889
890</div>
891
892<div id="linkbar">
893 <!-- <span id="linkbar-west">&nbsp;</span> -->
894 <span id="linkbar-center">
895 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
896 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
897 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
898 </span>
899 <span id="linkbar-east">&nbsp;</span>
900 </div>
901 <div class="footer">
902 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
903 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
904 </div>
905 <div style="clear: both; margin: 0; width: 100%; "></div>
906</body>
907</html>