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