Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / ffb69edc137c5ad509f39e4e2cdb1fefe792068a / . / www / api / magick-wand.html
blob: f5d5798a96122d5c9af9f9d3af9a5ebf2b9ffc5d [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>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]7 <title>ImageMagick: MagickWand, C API for ImageMagick: Wand Methods</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <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"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]30</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]48<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]49
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]52</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]53<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]54<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]55 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</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: Processing" href="../../www/command-line-processing.html">Processing</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: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</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: MagickWand" href="../../www/magick-wand.html">MagickWand</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: MagickCore" href="../../www/magick-core.html">MagickCore</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: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]93</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]94<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</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: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]119 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame^]122 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127
128<div class="sponsbox">
129<div class="sponsor">
cristy61105362010-12-19 23:22:14 +0000[diff] [blame]130 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <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]143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy6242f6a2010-02-18 02:20:56 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]149</div>
cristy96e13132010-06-07 14:55:44 +0000[diff] [blame]150</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]151</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]153
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]166</div>
167
168<div class="main">
169
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]170<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>
171
172<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
173_8c.html" target="source" name="ClearMagickWand">ClearMagickWand</a></h2>
174<div class="doc-section">
175
176<p>ClearMagickWand() clears resources associated with the wand.</p></ol>
177
178<p>The format of the ClearMagickWand method is:</p>
179
180<pre class="code">
181 void ClearMagickWand(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="CloneMagickWand">CloneMagickWand</a></h2>
192<div class="doc-section">
193
194<p>CloneMagickWand() makes an exact copy of the specified wand.</p></ol>
195
196<p>The format of the CloneMagickWand method is:</p>
197
198<pre class="code">
199 MagickWand *CloneMagickWand(const 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="DestroyMagickWand">DestroyMagickWand</a></h2>
210<div class="doc-section">
211
212<p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p></ol>
213
214<p>The format of the DestroyMagickWand method is:</p>
215
216<pre class="code">
217 MagickWand *DestroyMagickWand(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="IsMagickWand">IsMagickWand</a></h2>
228<div class="doc-section">
229
230<p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p></ol>
231
232<p>The format of the IsMagickWand method is:</p>
233
234<pre class="code">
235 MagickBooleanType IsMagickWand(const 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="MagickClearException">MagickClearException</a></h2>
246<div class="doc-section">
247
248<p>MagickClearException() clears any exceptions associated with the wand.</p></ol>
249
250<p>The format of the MagickClearException method is:</p>
251
252<pre class="code">
253 MagickBooleanType MagickClearException(MagickWand *wand)
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 </div>
262<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
263_8c.html" target="source" name="MagickGetException">MagickGetException</a></h2>
264<div class="doc-section">
265
266<p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
267
268<p>The format of the MagickGetException method is:</p>
269
270<pre class="code">
271 char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
272</pre>
273
274<p>A description of each parameter follows:</p></ol>
275
276<h5>wand</h5>
277<ol><p>the magick wand.</p></ol>
278
279<h5>severity</h5>
280<ol><p>the severity of the error is returned here.</p></ol>
281
282 </div>
283<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
284_8c.html" target="source" name="MagickGetExceptionType">MagickGetExceptionType</a></h2>
285<div class="doc-section">
286
287<p>MagickGetExceptionType() returns the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
288
289<p>The format of the MagickGetExceptionType method is:</p>
290
291<pre class="code">
292 ExceptionType MagickGetExceptionType(const MagickWand *wand)
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="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
303<div class="doc-section">
304
305<p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p></ol>
306
307<p>The format of the MagickGetIteratorIndex method is:</p>
308
309<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]310 ssize_t MagickGetIteratorIndex(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]311</pre>
312
313<p>A description of each parameter follows:</p></ol>
314
315<h5>wand</h5>
316<ol><p>the magick wand.</p></ol>
317
318 </div>
319<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
320_8c.html" target="source" name="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
321<div class="doc-section">
322
323<p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p></ol>
324
325<p>The format of the MagickQueryConfigureOption function is:</p>
326
327<pre class="text">
328 char *MagickQueryConfigureOption(const char *option)
329</pre>
330
331<p>A description of each parameter follows:</p></ol>
332
333<h5>option</h5>
334<ol><p>the option name.</p></ol>
335
336 </div>
337<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
338_8c.html" target="source" name="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
339<div class="doc-section">
340
341<p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g. "*" for all). Options include NAME, VERSION, LIB_VERSION, etc.</p></ol>
342
343<p>The format of the MagickQueryConfigureOptions function is:</p>
344
345<pre class="text">
346 char **MagickQueryConfigureOptions(const char *pattern,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]347 size_t *number_options)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]348</pre>
349
350<p>A description of each parameter follows:</p></ol>
351
352<h5>pattern</h5>
353<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
354
355<h5>number_options</h5>
356<ol><p>Returns the number of configure options in the list.</p></ol>
357
358
359 </div>
360<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
361_8c.html" target="source" name="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
362<div class="doc-section">
363
364<p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
365
366<pre class="text">
367 Element Description
368 -------------------------------------------------
369 0 character width
370 1 character height
371 2 ascender
372 3 descender
373 4 text width
374 5 text height
375 6 maximum horizontal advance
376 7 bounding box: x1
377 8 bounding box: y1
378 9 bounding box: x2
379 10 bounding box: y2
380 11 origin: x
381 12 origin: y
382</pre>
383
384<p>The format of the MagickQueryFontMetrics method is:</p>
385
386<pre class="code">
387 double *MagickQueryFontMetrics(MagickWand *wand,
388 const DrawingWand *drawing_wand,const char *text)
389</pre>
390
391<p>A description of each parameter follows:</p></ol>
392
393<h5>wand</h5>
394<ol><p>the Magick wand.</p></ol>
395
396<h5>drawing_wand</h5>
397<ol><p>the drawing wand.</p></ol>
398
399<h5>text</h5>
400<ol><p>the text.</p></ol>
401
402 </div>
403<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
404_8c.html" target="source" name="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
405<div class="doc-section">
406
407<p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
408
409<pre class="text">
410 Element Description
411 -------------------------------------------------
412 0 character width
413 1 character height
414 2 ascender
415 3 descender
416 4 text width
417 5 text height
418 6 maximum horizontal advance
419 7 bounding box: x1
420 8 bounding box: y1
421 9 bounding box: x2
422 10 bounding box: y2
423 11 origin: x
424 12 origin: y
425</pre>
426
427<p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
428
429<p>The format of the MagickQueryFontMetrics method is:</p>
430
431<pre class="code">
432 double *MagickQueryMultilineFontMetrics(MagickWand *wand,
433 const DrawingWand *drawing_wand,const char *text)
434</pre>
435
436<p>A description of each parameter follows:</p></ol>
437
438<h5>wand</h5>
439<ol><p>the Magick wand.</p></ol>
440
441<h5>drawing_wand</h5>
442<ol><p>the drawing wand.</p></ol>
443
444<h5>text</h5>
445<ol><p>the text.</p></ol>
446
447 </div>
448<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
449_8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
450<div class="doc-section">
451
452<p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p></ol>
453
454<p>The format of the MagickQueryFonts function is:</p>
455
456<pre class="text">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]457 char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]458</pre>
459
460<p>A description of each parameter follows:</p></ol>
461
462<h5>pattern</h5>
463<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
464
465<h5>number_fonts</h5>
466<ol><p>Returns the number of fonts in the list.</p></ol>
467
468
469 </div>
470<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
471_8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
472<div class="doc-section">
473
474<p>MagickQueryFonts() returns any image formats that match the specified pattern (e.g. "*" for all).</p></ol>
475
476<p>The format of the MagickQueryFonts function is:</p>
477
478<pre class="text">
479 char **MagickQueryFonts(const char *pattern,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]480 size_t *number_formats)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]481</pre>
482
483<p>A description of each parameter follows:</p></ol>
484
485<h5>pattern</h5>
486<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
487
488<h5>number_formats</h5>
489<ol><p>This integer returns the number of image formats in the list.</p></ol>
490
491 </div>
492<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
493_8c.html" target="source" name="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
494<div class="doc-section">
495
496<p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p></ol>
497
498<p>The format of the MagickRelinquishMemory method is:</p>
499
500<pre class="code">
501 void *MagickRelinquishMemory(void *resource)
502</pre>
503
504<p>A description of each parameter follows:</p></ol>
505
506<h5>resource</h5>
507<ol><p>Relinquish the memory associated with this resource.</p></ol>
508
509 </div>
510<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
511_8c.html" target="source" name="MagickResetIterator">MagickResetIterator</a></h2>
512<div class="doc-section">
513
514<p>MagickResetIterator() resets the wand iterator. Use it in conjunction with MagickNextImage() to iterate over all the images in a wand container.</p></ol>
515
516<p>The format of the MagickResetIterator method is:</p>
517
518<pre class="code">
519 void MagickResetIterator(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="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
530<div class="doc-section">
531
532<p>MagickSetFirstIterator() sets the wand iterator to the first image.</p></ol>
533
534<p>The format of the MagickSetFirstIterator method is:</p>
535
536<pre class="code">
537 void MagickSetFirstIterator(MagickWand *wand)
538</pre>
539
540<p>A description of each parameter follows:</p></ol>
541
542<h5>wand</h5>
543<ol><p>the magick wand.</p></ol>
544
545 </div>
546<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
547_8c.html" target="source" name="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
548<div class="doc-section">
549
550<p>MagickSetIteratorIndex() set the iterator to the position in the image list specified with the index parameter.</p></ol>
551
552<p>The format of the MagickSetIteratorIndex method is:</p>
553
554<pre class="code">
555 MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]556 const ssize_t index)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]557</pre>
558
559<p>A description of each parameter follows:</p></ol>
560
561<h5>wand</h5>
562<ol><p>the magick wand.</p></ol>
563
564<h5>index</h5>
565<ol><p>the scene number.</p></ol>
566
567 </div>
568<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
569_8c.html" target="source" name="MagickSetLastIterator">MagickSetLastIterator</a></h2>
570<div class="doc-section">
571
572<p>MagickSetLastIterator() sets the wand iterator to the last image.</p></ol>
573
574<p>The format of the MagickSetLastIterator method is:</p>
575
576<pre class="code">
577 void MagickSetLastIterator(MagickWand *wand)
578</pre>
579
580<p>A description of each parameter follows:</p></ol>
581
582<h5>wand</h5>
583<ol><p>the magick wand.</p></ol>
584
585 </div>
586<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
587_8c.html" target="source" name="MagickWandGenesis">MagickWandGenesis</a></h2>
588<div class="doc-section">
589
590<p>MagickWandGenesis() initializes the MagickWand environment.</p></ol>
591
592<p>The format of the MagickWandGenesis method is:</p>
593
594<pre class="code">
595 void MagickWandGenesis(void)
596</pre>
597
598 </div>
599<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
600_8c.html" target="source" name="MagickWandTerminus">MagickWandTerminus</a></h2>
601<div class="doc-section">
602
603<p>MagickWandTerminus() terminates the MagickWand environment.</p></ol>
604
605<p>The format of the MaickWandTerminus method is:</p>
606
607<pre class="code">
608 void MagickWandTerminus(void)
609</pre>
610
611 </div>
612<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
613_8c.html" target="source" name="NewMagickWand">NewMagickWand</a></h2>
614<div class="doc-section">
615
616<p>NewMagickWand() returns a wand required for all other methods in the API.</p></ol>
617
618<p>The format of the NewMagickWand method is:</p>
619
620<pre class="code">
621 MagickWand *NewMagickWand(void)
622</pre>
623
624 </div>
625<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
626_8c.html" target="source" name="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
627<div class="doc-section">
628
629<p>NewMagickWandFromImage() returns a wand with an image.</p></ol>
630
631<p>The format of the NewMagickWandFromImage method is:</p>
632
633<pre class="code">
634 MagickWand *NewMagickWandFromImage(const Image *image)
635</pre>
636
637<p>A description of each parameter follows:</p></ol>
638
639<h5>image</h5>
640<ol><p>the image.</p></ol>
641
642 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]643
644</div>
645
646<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]647 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]648 <span id="linkbar-center">
649 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]650 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]651 </span>
652 <span id="linkbar-east">&nbsp;</span>
653 </div>
654 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]655 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]656 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
657 </div>
658 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]659 <script type="text/javascript">
660 var _gaq = _gaq || [];
661 _gaq.push(['_setAccount', 'UA-17690367-1']);
662 _gaq.push(['_trackPageview']);
663
664 (function() {
665 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
666 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
667 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
668 })();
669 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]670</body>
671</html>