Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 3eaa0efda2a6fd5d8e8426b53e578ddcacb1c45f / . / www / api / magick-wand.html
blob: fd714aee3272cc6f8a54d8784989e53484d925ce [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">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5 <meta http-equiv="Content-Type" value="application/xhtml+xml" />
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: Wand 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:, wmethods, 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">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame^]127 <a href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]128</div>
129<div class="sponsor">
130 <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy6242f6a2010-02-18 02:20:56 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]133 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
134</div>
135<div class="sponsor">
cristycdbe2742010-02-07 19:30:44 +0000[diff] [blame]136 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]139 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]142 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
143</div>
144<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]145 <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]148 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]149</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame^]152
153
154</div>
155
156<div class="main">
157
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]158<p class="navigation-index">[<a href="#ClearMagickWand">ClearMagickWand</a> &bull; <a href="#CloneMagickWand">CloneMagickWand</a> &bull; <a href="#DestroyMagickWand">DestroyMagickWand</a> &bull; <a href="#IsMagickWand">IsMagickWand</a> &bull; <a href="#MagickClearException">MagickClearException</a> &bull; <a href="#MagickGetException">MagickGetException</a> &bull; <a href="#MagickGetExceptionType">MagickGetExceptionType</a> &bull; <a href="#MagickGetIteratorIndex">MagickGetIteratorIndex</a> &bull; <a href="#MagickQueryConfigureOption">MagickQueryConfigureOption</a> &bull; <a href="#MagickQueryConfigureOptions">MagickQueryConfigureOptions</a> &bull; <a href="#MagickQueryFontMetrics">MagickQueryFontMetrics</a> &bull; <a href="#MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a> &bull; <a href="#MagickQueryFonts">MagickQueryFonts</a> &bull; <a href="#MagickQueryFonts">MagickQueryFonts</a> &bull; <a href="#MagickRelinquishMemory">MagickRelinquishMemory</a> &bull; <a href="#MagickResetIterator">MagickResetIterator</a> &bull; <a href="#MagickSetFirstIterator">MagickSetFirstIterator</a> &bull; <a href="#MagickSetIteratorIndex">MagickSetIteratorIndex</a> &bull; <a href="#MagickSetLastIterator">MagickSetLastIterator</a> &bull; <a href="#MagickWandGenesis">MagickWandGenesis</a> &bull; <a href="#MagickWandTerminus">MagickWandTerminus</a> &bull; <a href="#NewMagickWand">NewMagickWand</a> &bull; <a href="#NewMagickWandFromImage">NewMagickWandFromImage</a>]</p>
159
160<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
161_8c.html" target="source" name="ClearMagickWand">ClearMagickWand</a></h2>
162<div class="doc-section">
163
164<p>ClearMagickWand() clears resources associated with the wand.</p></ol>
165
166<p>The format of the ClearMagickWand method is:</p>
167
168<pre class="code">
169 void ClearMagickWand(MagickWand *wand)
170</pre>
171
172<p>A description of each parameter follows:</p></ol>
173
174<h5>wand</h5>
175<ol><p>the magick wand.</p></ol>
176
177 </div>
178<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
179_8c.html" target="source" name="CloneMagickWand">CloneMagickWand</a></h2>
180<div class="doc-section">
181
182<p>CloneMagickWand() makes an exact copy of the specified wand.</p></ol>
183
184<p>The format of the CloneMagickWand method is:</p>
185
186<pre class="code">
187 MagickWand *CloneMagickWand(const MagickWand *wand)
188</pre>
189
190<p>A description of each parameter follows:</p></ol>
191
192<h5>wand</h5>
193<ol><p>the magick wand.</p></ol>
194
195 </div>
196<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
197_8c.html" target="source" name="DestroyMagickWand">DestroyMagickWand</a></h2>
198<div class="doc-section">
199
200<p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p></ol>
201
202<p>The format of the DestroyMagickWand method is:</p>
203
204<pre class="code">
205 MagickWand *DestroyMagickWand(MagickWand *wand)
206</pre>
207
208<p>A description of each parameter follows:</p></ol>
209
210<h5>wand</h5>
211<ol><p>the magick wand.</p></ol>
212
213 </div>
214<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
215_8c.html" target="source" name="IsMagickWand">IsMagickWand</a></h2>
216<div class="doc-section">
217
218<p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p></ol>
219
220<p>The format of the IsMagickWand method is:</p>
221
222<pre class="code">
223 MagickBooleanType IsMagickWand(const MagickWand *wand)
224</pre>
225
226<p>A description of each parameter follows:</p></ol>
227
228<h5>wand</h5>
229<ol><p>the magick wand.</p></ol>
230
231 </div>
232<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
233_8c.html" target="source" name="MagickClearException">MagickClearException</a></h2>
234<div class="doc-section">
235
236<p>MagickClearException() clears any exceptions associated with the wand.</p></ol>
237
238<p>The format of the MagickClearException method is:</p>
239
240<pre class="code">
241 MagickBooleanType MagickClearException(MagickWand *wand)
242</pre>
243
244<p>A description of each parameter follows:</p></ol>
245
246<h5>wand</h5>
247<ol><p>the magick wand.</p></ol>
248
249 </div>
250<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
251_8c.html" target="source" name="MagickGetException">MagickGetException</a></h2>
252<div class="doc-section">
253
254<p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
255
256<p>The format of the MagickGetException method is:</p>
257
258<pre class="code">
259 char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
260</pre>
261
262<p>A description of each parameter follows:</p></ol>
263
264<h5>wand</h5>
265<ol><p>the magick wand.</p></ol>
266
267<h5>severity</h5>
268<ol><p>the severity of the error is returned here.</p></ol>
269
270 </div>
271<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
272_8c.html" target="source" name="MagickGetExceptionType">MagickGetExceptionType</a></h2>
273<div class="doc-section">
274
275<p>MagickGetExceptionType() returns the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
276
277<p>The format of the MagickGetExceptionType method is:</p>
278
279<pre class="code">
280 ExceptionType MagickGetExceptionType(const MagickWand *wand)
281</pre>
282
283<p>A description of each parameter follows:</p></ol>
284
285<h5>wand</h5>
286<ol><p>the magick wand.</p></ol>
287
288 </div>
289<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
290_8c.html" target="source" name="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
291<div class="doc-section">
292
293<p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p></ol>
294
295<p>The format of the MagickGetIteratorIndex method is:</p>
296
297<pre class="code">
298 long MagickGetIteratorIndex(MagickWand *wand)
299</pre>
300
301<p>A description of each parameter follows:</p></ol>
302
303<h5>wand</h5>
304<ol><p>the magick wand.</p></ol>
305
306 </div>
307<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
308_8c.html" target="source" name="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
309<div class="doc-section">
310
311<p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p></ol>
312
313<p>The format of the MagickQueryConfigureOption function is:</p>
314
315<pre class="text">
316 char *MagickQueryConfigureOption(const char *option)
317</pre>
318
319<p>A description of each parameter follows:</p></ol>
320
321<h5>option</h5>
322<ol><p>the option name.</p></ol>
323
324 </div>
325<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
326_8c.html" target="source" name="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
327<div class="doc-section">
328
329<p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g. "*" for all). Options include NAME, VERSION, LIB_VERSION, etc.</p></ol>
330
331<p>The format of the MagickQueryConfigureOptions function is:</p>
332
333<pre class="text">
334 char **MagickQueryConfigureOptions(const char *pattern,
335 unsigned long *number_options)
336</pre>
337
338<p>A description of each parameter follows:</p></ol>
339
340<h5>pattern</h5>
341<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
342
343<h5>number_options</h5>
344<ol><p>Returns the number of configure options in the list.</p></ol>
345
346
347 </div>
348<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
349_8c.html" target="source" name="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
350<div class="doc-section">
351
352<p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
353
354<pre class="text">
355 Element Description
356 -------------------------------------------------
357 0 character width
358 1 character height
359 2 ascender
360 3 descender
361 4 text width
362 5 text height
363 6 maximum horizontal advance
364 7 bounding box: x1
365 8 bounding box: y1
366 9 bounding box: x2
367 10 bounding box: y2
368 11 origin: x
369 12 origin: y
370</pre>
371
372<p>The format of the MagickQueryFontMetrics method is:</p>
373
374<pre class="code">
375 double *MagickQueryFontMetrics(MagickWand *wand,
376 const DrawingWand *drawing_wand,const char *text)
377</pre>
378
379<p>A description of each parameter follows:</p></ol>
380
381<h5>wand</h5>
382<ol><p>the Magick wand.</p></ol>
383
384<h5>drawing_wand</h5>
385<ol><p>the drawing wand.</p></ol>
386
387<h5>text</h5>
388<ol><p>the text.</p></ol>
389
390 </div>
391<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
392_8c.html" target="source" name="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
393<div class="doc-section">
394
395<p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
396
397<pre class="text">
398 Element Description
399 -------------------------------------------------
400 0 character width
401 1 character height
402 2 ascender
403 3 descender
404 4 text width
405 5 text height
406 6 maximum horizontal advance
407 7 bounding box: x1
408 8 bounding box: y1
409 9 bounding box: x2
410 10 bounding box: y2
411 11 origin: x
412 12 origin: y
413</pre>
414
415<p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
416
417<p>The format of the MagickQueryFontMetrics method is:</p>
418
419<pre class="code">
420 double *MagickQueryMultilineFontMetrics(MagickWand *wand,
421 const DrawingWand *drawing_wand,const char *text)
422</pre>
423
424<p>A description of each parameter follows:</p></ol>
425
426<h5>wand</h5>
427<ol><p>the Magick wand.</p></ol>
428
429<h5>drawing_wand</h5>
430<ol><p>the drawing wand.</p></ol>
431
432<h5>text</h5>
433<ol><p>the text.</p></ol>
434
435 </div>
436<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
437_8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
438<div class="doc-section">
439
440<p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p></ol>
441
442<p>The format of the MagickQueryFonts function is:</p>
443
444<pre class="text">
445 char **MagickQueryFonts(const char *pattern,unsigned long *number_fonts)
446</pre>
447
448<p>A description of each parameter follows:</p></ol>
449
450<h5>pattern</h5>
451<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
452
453<h5>number_fonts</h5>
454<ol><p>Returns the number of fonts in the list.</p></ol>
455
456
457 </div>
458<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
459_8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
460<div class="doc-section">
461
462<p>MagickQueryFonts() returns any image formats that match the specified pattern (e.g. "*" for all).</p></ol>
463
464<p>The format of the MagickQueryFonts function is:</p>
465
466<pre class="text">
467 char **MagickQueryFonts(const char *pattern,
468 unsigned long *number_formats)
469</pre>
470
471<p>A description of each parameter follows:</p></ol>
472
473<h5>pattern</h5>
474<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
475
476<h5>number_formats</h5>
477<ol><p>This integer returns the number of image formats in the list.</p></ol>
478
479 </div>
480<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
481_8c.html" target="source" name="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
482<div class="doc-section">
483
484<p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p></ol>
485
486<p>The format of the MagickRelinquishMemory method is:</p>
487
488<pre class="code">
489 void *MagickRelinquishMemory(void *resource)
490</pre>
491
492<p>A description of each parameter follows:</p></ol>
493
494<h5>resource</h5>
495<ol><p>Relinquish the memory associated with this resource.</p></ol>
496
497 </div>
498<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
499_8c.html" target="source" name="MagickResetIterator">MagickResetIterator</a></h2>
500<div class="doc-section">
501
502<p>MagickResetIterator() resets the wand iterator. Use it in conjunction with MagickNextImage() to iterate over all the images in a wand container.</p></ol>
503
504<p>The format of the MagickResetIterator method is:</p>
505
506<pre class="code">
507 void MagickResetIterator(MagickWand *wand)
508</pre>
509
510<p>A description of each parameter follows:</p></ol>
511
512<h5>wand</h5>
513<ol><p>the magick wand.</p></ol>
514
515 </div>
516<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
517_8c.html" target="source" name="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
518<div class="doc-section">
519
520<p>MagickSetFirstIterator() sets the wand iterator to the first image.</p></ol>
521
522<p>The format of the MagickSetFirstIterator method is:</p>
523
524<pre class="code">
525 void MagickSetFirstIterator(MagickWand *wand)
526</pre>
527
528<p>A description of each parameter follows:</p></ol>
529
530<h5>wand</h5>
531<ol><p>the magick wand.</p></ol>
532
533 </div>
534<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
535_8c.html" target="source" name="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
536<div class="doc-section">
537
538<p>MagickSetIteratorIndex() set the iterator to the position in the image list specified with the index parameter.</p></ol>
539
540<p>The format of the MagickSetIteratorIndex method is:</p>
541
542<pre class="code">
543 MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
544 const long index)
545</pre>
546
547<p>A description of each parameter follows:</p></ol>
548
549<h5>wand</h5>
550<ol><p>the magick wand.</p></ol>
551
552<h5>index</h5>
553<ol><p>the scene number.</p></ol>
554
555 </div>
556<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
557_8c.html" target="source" name="MagickSetLastIterator">MagickSetLastIterator</a></h2>
558<div class="doc-section">
559
560<p>MagickSetLastIterator() sets the wand iterator to the last image.</p></ol>
561
562<p>The format of the MagickSetLastIterator method is:</p>
563
564<pre class="code">
565 void MagickSetLastIterator(MagickWand *wand)
566</pre>
567
568<p>A description of each parameter follows:</p></ol>
569
570<h5>wand</h5>
571<ol><p>the magick wand.</p></ol>
572
573 </div>
574<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
575_8c.html" target="source" name="MagickWandGenesis">MagickWandGenesis</a></h2>
576<div class="doc-section">
577
578<p>MagickWandGenesis() initializes the MagickWand environment.</p></ol>
579
580<p>The format of the MagickWandGenesis method is:</p>
581
582<pre class="code">
583 void MagickWandGenesis(void)
584</pre>
585
586 </div>
587<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
588_8c.html" target="source" name="MagickWandTerminus">MagickWandTerminus</a></h2>
589<div class="doc-section">
590
591<p>MagickWandTerminus() terminates the MagickWand environment.</p></ol>
592
593<p>The format of the MaickWandTerminus method is:</p>
594
595<pre class="code">
596 void MagickWandTerminus(void)
597</pre>
598
599 </div>
600<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
601_8c.html" target="source" name="NewMagickWand">NewMagickWand</a></h2>
602<div class="doc-section">
603
604<p>NewMagickWand() returns a wand required for all other methods in the API.</p></ol>
605
606<p>The format of the NewMagickWand method is:</p>
607
608<pre class="code">
609 MagickWand *NewMagickWand(void)
610</pre>
611
612 </div>
613<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
614_8c.html" target="source" name="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
615<div class="doc-section">
616
617<p>NewMagickWandFromImage() returns a wand with an image.</p></ol>
618
619<p>The format of the NewMagickWandFromImage method is:</p>
620
621<pre class="code">
622 MagickWand *NewMagickWandFromImage(const Image *image)
623</pre>
624
625<p>A description of each parameter follows:</p></ol>
626
627<h5>image</h5>
628<ol><p>the image.</p></ol>
629
630 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame^]631
632</div>
633
634<div id="linkbar">
635 <!-- <span id="linkbar-west">&nbsp;</span> -->
636 <span id="linkbar-center">
637 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
638 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
639 </span>
640 <span id="linkbar-east">&nbsp;</span>
641 </div>
642 <div class="footer">
643 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
644 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
645 </div>
646 <div style="clear: both; margin: 0; width: 100%; "></div>
647</body>
648</html>