Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 8542c85ac0fbc675b0f3c0f992cff5a83971f54a / . / www / api / magick-wand.html
blob: 0422cd251d931490be695e4caf8fee9765903ac6 [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>
cristy3de29cc2010-04-15 02:34:44 +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" />
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]8 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]9 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]52 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
53</div>
54<div class="sub">
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
62</div>
63<div class="sep"></div>
64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]91<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124
125<div class="sponsbox">
126<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristycdfd3c22010-03-08 01:08:11 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy6242f6a2010-02-18 02:20:56 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Sponsor: Kredit" 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">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +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
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]152<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>
153
154<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
155_8c.html" target="source" name="ClearMagickWand">ClearMagickWand</a></h2>
156<div class="doc-section">
157
158<p>ClearMagickWand() clears resources associated with the wand.</p></ol>
159
160<p>The format of the ClearMagickWand method is:</p>
161
162<pre class="code">
163 void ClearMagickWand(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/magick-wand
173_8c.html" target="source" name="CloneMagickWand">CloneMagickWand</a></h2>
174<div class="doc-section">
175
176<p>CloneMagickWand() makes an exact copy of the specified wand.</p></ol>
177
178<p>The format of the CloneMagickWand method is:</p>
179
180<pre class="code">
181 MagickWand *CloneMagickWand(const MagickWand *wand)
182</pre>
183
184<p>A description of each parameter follows:</p></ol>
185
186<h5>wand</h5>
187<ol><p>the magick wand.</p></ol>
188
189 </div>
190<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
191_8c.html" target="source" name="DestroyMagickWand">DestroyMagickWand</a></h2>
192<div class="doc-section">
193
194<p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p></ol>
195
196<p>The format of the DestroyMagickWand method is:</p>
197
198<pre class="code">
199 MagickWand *DestroyMagickWand(MagickWand *wand)
200</pre>
201
202<p>A description of each parameter follows:</p></ol>
203
204<h5>wand</h5>
205<ol><p>the magick wand.</p></ol>
206
207 </div>
208<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
209_8c.html" target="source" name="IsMagickWand">IsMagickWand</a></h2>
210<div class="doc-section">
211
212<p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p></ol>
213
214<p>The format of the IsMagickWand method is:</p>
215
216<pre class="code">
217 MagickBooleanType IsMagickWand(const MagickWand *wand)
218</pre>
219
220<p>A description of each parameter follows:</p></ol>
221
222<h5>wand</h5>
223<ol><p>the magick wand.</p></ol>
224
225 </div>
226<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
227_8c.html" target="source" name="MagickClearException">MagickClearException</a></h2>
228<div class="doc-section">
229
230<p>MagickClearException() clears any exceptions associated with the wand.</p></ol>
231
232<p>The format of the MagickClearException method is:</p>
233
234<pre class="code">
235 MagickBooleanType MagickClearException(MagickWand *wand)
236</pre>
237
238<p>A description of each parameter follows:</p></ol>
239
240<h5>wand</h5>
241<ol><p>the magick wand.</p></ol>
242
243 </div>
244<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
245_8c.html" target="source" name="MagickGetException">MagickGetException</a></h2>
246<div class="doc-section">
247
248<p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
249
250<p>The format of the MagickGetException method is:</p>
251
252<pre class="code">
253 char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
254</pre>
255
256<p>A description of each parameter follows:</p></ol>
257
258<h5>wand</h5>
259<ol><p>the magick wand.</p></ol>
260
261<h5>severity</h5>
262<ol><p>the severity of the error is returned here.</p></ol>
263
264 </div>
265<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
266_8c.html" target="source" name="MagickGetExceptionType">MagickGetExceptionType</a></h2>
267<div class="doc-section">
268
269<p>MagickGetExceptionType() returns the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
270
271<p>The format of the MagickGetExceptionType method is:</p>
272
273<pre class="code">
274 ExceptionType MagickGetExceptionType(const MagickWand *wand)
275</pre>
276
277<p>A description of each parameter follows:</p></ol>
278
279<h5>wand</h5>
280<ol><p>the magick wand.</p></ol>
281
282 </div>
283<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
284_8c.html" target="source" name="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
285<div class="doc-section">
286
287<p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p></ol>
288
289<p>The format of the MagickGetIteratorIndex method is:</p>
290
291<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]292 ssize_t MagickGetIteratorIndex(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]293</pre>
294
295<p>A description of each parameter follows:</p></ol>
296
297<h5>wand</h5>
298<ol><p>the magick wand.</p></ol>
299
300 </div>
301<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
302_8c.html" target="source" name="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
303<div class="doc-section">
304
305<p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p></ol>
306
307<p>The format of the MagickQueryConfigureOption function is:</p>
308
309<pre class="text">
310 char *MagickQueryConfigureOption(const char *option)
311</pre>
312
313<p>A description of each parameter follows:</p></ol>
314
315<h5>option</h5>
316<ol><p>the option name.</p></ol>
317
318 </div>
319<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
320_8c.html" target="source" name="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
321<div class="doc-section">
322
323<p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g. "*" for all). Options include NAME, VERSION, LIB_VERSION, etc.</p></ol>
324
325<p>The format of the MagickQueryConfigureOptions function is:</p>
326
327<pre class="text">
328 char **MagickQueryConfigureOptions(const char *pattern,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]329 size_t *number_options)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]330</pre>
331
332<p>A description of each parameter follows:</p></ol>
333
334<h5>pattern</h5>
335<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
336
337<h5>number_options</h5>
338<ol><p>Returns the number of configure options in the list.</p></ol>
339
340
341 </div>
342<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
343_8c.html" target="source" name="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
344<div class="doc-section">
345
346<p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
347
348<pre class="text">
349 Element Description
350 -------------------------------------------------
351 0 character width
352 1 character height
353 2 ascender
354 3 descender
355 4 text width
356 5 text height
357 6 maximum horizontal advance
358 7 bounding box: x1
359 8 bounding box: y1
360 9 bounding box: x2
361 10 bounding box: y2
362 11 origin: x
363 12 origin: y
364</pre>
365
366<p>The format of the MagickQueryFontMetrics method is:</p>
367
368<pre class="code">
369 double *MagickQueryFontMetrics(MagickWand *wand,
370 const DrawingWand *drawing_wand,const char *text)
371</pre>
372
373<p>A description of each parameter follows:</p></ol>
374
375<h5>wand</h5>
376<ol><p>the Magick wand.</p></ol>
377
378<h5>drawing_wand</h5>
379<ol><p>the drawing wand.</p></ol>
380
381<h5>text</h5>
382<ol><p>the text.</p></ol>
383
384 </div>
385<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
386_8c.html" target="source" name="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
387<div class="doc-section">
388
389<p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
390
391<pre class="text">
392 Element Description
393 -------------------------------------------------
394 0 character width
395 1 character height
396 2 ascender
397 3 descender
398 4 text width
399 5 text height
400 6 maximum horizontal advance
401 7 bounding box: x1
402 8 bounding box: y1
403 9 bounding box: x2
404 10 bounding box: y2
405 11 origin: x
406 12 origin: y
407</pre>
408
409<p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
410
411<p>The format of the MagickQueryFontMetrics method is:</p>
412
413<pre class="code">
414 double *MagickQueryMultilineFontMetrics(MagickWand *wand,
415 const DrawingWand *drawing_wand,const char *text)
416</pre>
417
418<p>A description of each parameter follows:</p></ol>
419
420<h5>wand</h5>
421<ol><p>the Magick wand.</p></ol>
422
423<h5>drawing_wand</h5>
424<ol><p>the drawing wand.</p></ol>
425
426<h5>text</h5>
427<ol><p>the text.</p></ol>
428
429 </div>
430<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
431_8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
432<div class="doc-section">
433
434<p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p></ol>
435
436<p>The format of the MagickQueryFonts function is:</p>
437
438<pre class="text">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]439 char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]440</pre>
441
442<p>A description of each parameter follows:</p></ol>
443
444<h5>pattern</h5>
445<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
446
447<h5>number_fonts</h5>
448<ol><p>Returns the number of fonts in the list.</p></ol>
449
450
451 </div>
452<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
453_8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
454<div class="doc-section">
455
456<p>MagickQueryFonts() returns any image formats that match the specified pattern (e.g. "*" for all).</p></ol>
457
458<p>The format of the MagickQueryFonts function is:</p>
459
460<pre class="text">
461 char **MagickQueryFonts(const char *pattern,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]462 size_t *number_formats)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]463</pre>
464
465<p>A description of each parameter follows:</p></ol>
466
467<h5>pattern</h5>
468<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
469
470<h5>number_formats</h5>
471<ol><p>This integer returns the number of image formats in the list.</p></ol>
472
473 </div>
474<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
475_8c.html" target="source" name="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
476<div class="doc-section">
477
478<p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p></ol>
479
480<p>The format of the MagickRelinquishMemory method is:</p>
481
482<pre class="code">
483 void *MagickRelinquishMemory(void *resource)
484</pre>
485
486<p>A description of each parameter follows:</p></ol>
487
488<h5>resource</h5>
489<ol><p>Relinquish the memory associated with this resource.</p></ol>
490
491 </div>
492<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
493_8c.html" target="source" name="MagickResetIterator">MagickResetIterator</a></h2>
494<div class="doc-section">
495
496<p>MagickResetIterator() resets the wand iterator. Use it in conjunction with MagickNextImage() to iterate over all the images in a wand container.</p></ol>
497
498<p>The format of the MagickResetIterator method is:</p>
499
500<pre class="code">
501 void MagickResetIterator(MagickWand *wand)
502</pre>
503
504<p>A description of each parameter follows:</p></ol>
505
506<h5>wand</h5>
507<ol><p>the magick wand.</p></ol>
508
509 </div>
510<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
511_8c.html" target="source" name="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
512<div class="doc-section">
513
514<p>MagickSetFirstIterator() sets the wand iterator to the first image.</p></ol>
515
516<p>The format of the MagickSetFirstIterator method is:</p>
517
518<pre class="code">
519 void MagickSetFirstIterator(MagickWand *wand)
520</pre>
521
522<p>A description of each parameter follows:</p></ol>
523
524<h5>wand</h5>
525<ol><p>the magick wand.</p></ol>
526
527 </div>
528<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
529_8c.html" target="source" name="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
530<div class="doc-section">
531
532<p>MagickSetIteratorIndex() set the iterator to the position in the image list specified with the index parameter.</p></ol>
533
534<p>The format of the MagickSetIteratorIndex method is:</p>
535
536<pre class="code">
537 MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]538 const ssize_t index)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]539</pre>
540
541<p>A description of each parameter follows:</p></ol>
542
543<h5>wand</h5>
544<ol><p>the magick wand.</p></ol>
545
546<h5>index</h5>
547<ol><p>the scene number.</p></ol>
548
549 </div>
550<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
551_8c.html" target="source" name="MagickSetLastIterator">MagickSetLastIterator</a></h2>
552<div class="doc-section">
553
554<p>MagickSetLastIterator() sets the wand iterator to the last image.</p></ol>
555
556<p>The format of the MagickSetLastIterator method is:</p>
557
558<pre class="code">
559 void MagickSetLastIterator(MagickWand *wand)
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 </div>
568<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
569_8c.html" target="source" name="MagickWandGenesis">MagickWandGenesis</a></h2>
570<div class="doc-section">
571
572<p>MagickWandGenesis() initializes the MagickWand environment.</p></ol>
573
574<p>The format of the MagickWandGenesis method is:</p>
575
576<pre class="code">
577 void MagickWandGenesis(void)
578</pre>
579
580 </div>
581<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
582_8c.html" target="source" name="MagickWandTerminus">MagickWandTerminus</a></h2>
583<div class="doc-section">
584
585<p>MagickWandTerminus() terminates the MagickWand environment.</p></ol>
586
587<p>The format of the MaickWandTerminus method is:</p>
588
589<pre class="code">
590 void MagickWandTerminus(void)
591</pre>
592
593 </div>
594<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
595_8c.html" target="source" name="NewMagickWand">NewMagickWand</a></h2>
596<div class="doc-section">
597
598<p>NewMagickWand() returns a wand required for all other methods in the API.</p></ol>
599
600<p>The format of the NewMagickWand method is:</p>
601
602<pre class="code">
603 MagickWand *NewMagickWand(void)
604</pre>
605
606 </div>
607<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
608_8c.html" target="source" name="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
609<div class="doc-section">
610
611<p>NewMagickWandFromImage() returns a wand with an image.</p></ol>
612
613<p>The format of the NewMagickWandFromImage method is:</p>
614
615<pre class="code">
616 MagickWand *NewMagickWandFromImage(const Image *image)
617</pre>
618
619<p>A description of each parameter follows:</p></ol>
620
621<h5>image</h5>
622<ol><p>the image.</p></ol>
623
624 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]625
626</div>
627
628<div id="linkbar">
629 <!-- <span id="linkbar-west">&nbsp;</span> -->
630 <span id="linkbar-center">
631 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristyc3186d52010-06-04 13:55:23 +0000[diff] [blame]632 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]633 </span>
634 <span id="linkbar-east">&nbsp;</span>
635 </div>
636 <div class="footer">
637 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
638 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
639 </div>
640 <div style="clear: both; margin: 0; width: 100%; "></div>
641</body>
642</html>