Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 307ba18d4753632f19e873143d01e0b6ba2dbaad / . / www / api / magick-wand.html
blob: 5fd3df7aac75741a4c00a66f1a3d326d5cf392d5 [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">
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame^]130 <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011040100025 gabi.schulze-->
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
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame^]170<h1>Module magick-wand
171 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]172<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>
173
174<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
175_8c.html" target="source" name="ClearMagickWand">ClearMagickWand</a></h2>
176<div class="doc-section">
177
178<p>ClearMagickWand() clears resources associated with the wand.</p></ol>
179
180<p>The format of the ClearMagickWand method is:</p>
181
182<pre class="code">
183 void ClearMagickWand(MagickWand *wand)
184</pre>
185
186<p>A description of each parameter follows:</p></ol>
187
188<h5>wand</h5>
189<ol><p>the magick wand.</p></ol>
190
191 </div>
192<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
193_8c.html" target="source" name="CloneMagickWand">CloneMagickWand</a></h2>
194<div class="doc-section">
195
196<p>CloneMagickWand() makes an exact copy of the specified wand.</p></ol>
197
198<p>The format of the CloneMagickWand method is:</p>
199
200<pre class="code">
201 MagickWand *CloneMagickWand(const MagickWand *wand)
202</pre>
203
204<p>A description of each parameter follows:</p></ol>
205
206<h5>wand</h5>
207<ol><p>the magick wand.</p></ol>
208
209 </div>
210<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
211_8c.html" target="source" name="DestroyMagickWand">DestroyMagickWand</a></h2>
212<div class="doc-section">
213
214<p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p></ol>
215
216<p>The format of the DestroyMagickWand method is:</p>
217
218<pre class="code">
219 MagickWand *DestroyMagickWand(MagickWand *wand)
220</pre>
221
222<p>A description of each parameter follows:</p></ol>
223
224<h5>wand</h5>
225<ol><p>the magick wand.</p></ol>
226
227 </div>
228<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
229_8c.html" target="source" name="IsMagickWand">IsMagickWand</a></h2>
230<div class="doc-section">
231
232<p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p></ol>
233
234<p>The format of the IsMagickWand method is:</p>
235
236<pre class="code">
237 MagickBooleanType IsMagickWand(const MagickWand *wand)
238</pre>
239
240<p>A description of each parameter follows:</p></ol>
241
242<h5>wand</h5>
243<ol><p>the magick wand.</p></ol>
244
245 </div>
246<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
247_8c.html" target="source" name="MagickClearException">MagickClearException</a></h2>
248<div class="doc-section">
249
250<p>MagickClearException() clears any exceptions associated with the wand.</p></ol>
251
252<p>The format of the MagickClearException method is:</p>
253
254<pre class="code">
255 MagickBooleanType MagickClearException(MagickWand *wand)
256</pre>
257
258<p>A description of each parameter follows:</p></ol>
259
260<h5>wand</h5>
261<ol><p>the magick wand.</p></ol>
262
263 </div>
264<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
265_8c.html" target="source" name="MagickGetException">MagickGetException</a></h2>
266<div class="doc-section">
267
268<p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
269
270<p>The format of the MagickGetException method is:</p>
271
272<pre class="code">
273 char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
274</pre>
275
276<p>A description of each parameter follows:</p></ol>
277
278<h5>wand</h5>
279<ol><p>the magick wand.</p></ol>
280
281<h5>severity</h5>
282<ol><p>the severity of the error is returned here.</p></ol>
283
284 </div>
285<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
286_8c.html" target="source" name="MagickGetExceptionType">MagickGetExceptionType</a></h2>
287<div class="doc-section">
288
289<p>MagickGetExceptionType() returns the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
290
291<p>The format of the MagickGetExceptionType method is:</p>
292
293<pre class="code">
294 ExceptionType MagickGetExceptionType(const MagickWand *wand)
295</pre>
296
297<p>A description of each parameter follows:</p></ol>
298
299<h5>wand</h5>
300<ol><p>the magick wand.</p></ol>
301
302 </div>
303<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
304_8c.html" target="source" name="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
305<div class="doc-section">
306
307<p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p></ol>
308
309<p>The format of the MagickGetIteratorIndex method is:</p>
310
311<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]312 ssize_t MagickGetIteratorIndex(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]313</pre>
314
315<p>A description of each parameter follows:</p></ol>
316
317<h5>wand</h5>
318<ol><p>the magick wand.</p></ol>
319
320 </div>
321<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
322_8c.html" target="source" name="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
323<div class="doc-section">
324
325<p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p></ol>
326
327<p>The format of the MagickQueryConfigureOption function is:</p>
328
329<pre class="text">
330 char *MagickQueryConfigureOption(const char *option)
331</pre>
332
333<p>A description of each parameter follows:</p></ol>
334
335<h5>option</h5>
336<ol><p>the option name.</p></ol>
337
338 </div>
339<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
340_8c.html" target="source" name="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
341<div class="doc-section">
342
343<p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g. "*" for all). Options include NAME, VERSION, LIB_VERSION, etc.</p></ol>
344
345<p>The format of the MagickQueryConfigureOptions function is:</p>
346
347<pre class="text">
348 char **MagickQueryConfigureOptions(const char *pattern,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]349 size_t *number_options)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]350</pre>
351
352<p>A description of each parameter follows:</p></ol>
353
354<h5>pattern</h5>
355<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
356
357<h5>number_options</h5>
358<ol><p>Returns the number of configure options in the list.</p></ol>
359
360
361 </div>
362<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
363_8c.html" target="source" name="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
364<div class="doc-section">
365
366<p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
367
368<pre class="text">
369 Element Description
370 -------------------------------------------------
371 0 character width
372 1 character height
373 2 ascender
374 3 descender
375 4 text width
376 5 text height
377 6 maximum horizontal advance
378 7 bounding box: x1
379 8 bounding box: y1
380 9 bounding box: x2
381 10 bounding box: y2
382 11 origin: x
383 12 origin: y
384</pre>
385
386<p>The format of the MagickQueryFontMetrics method is:</p>
387
388<pre class="code">
389 double *MagickQueryFontMetrics(MagickWand *wand,
390 const DrawingWand *drawing_wand,const char *text)
391</pre>
392
393<p>A description of each parameter follows:</p></ol>
394
395<h5>wand</h5>
396<ol><p>the Magick wand.</p></ol>
397
398<h5>drawing_wand</h5>
399<ol><p>the drawing wand.</p></ol>
400
401<h5>text</h5>
402<ol><p>the text.</p></ol>
403
404 </div>
405<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
406_8c.html" target="source" name="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
407<div class="doc-section">
408
409<p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
410
411<pre class="text">
412 Element Description
413 -------------------------------------------------
414 0 character width
415 1 character height
416 2 ascender
417 3 descender
418 4 text width
419 5 text height
420 6 maximum horizontal advance
421 7 bounding box: x1
422 8 bounding box: y1
423 9 bounding box: x2
424 10 bounding box: y2
425 11 origin: x
426 12 origin: y
427</pre>
428
429<p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p></ol>
430
431<p>The format of the MagickQueryFontMetrics method is:</p>
432
433<pre class="code">
434 double *MagickQueryMultilineFontMetrics(MagickWand *wand,
435 const DrawingWand *drawing_wand,const char *text)
436</pre>
437
438<p>A description of each parameter follows:</p></ol>
439
440<h5>wand</h5>
441<ol><p>the Magick wand.</p></ol>
442
443<h5>drawing_wand</h5>
444<ol><p>the drawing wand.</p></ol>
445
446<h5>text</h5>
447<ol><p>the text.</p></ol>
448
449 </div>
450<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
451_8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
452<div class="doc-section">
453
454<p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p></ol>
455
456<p>The format of the MagickQueryFonts function is:</p>
457
458<pre class="text">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]459 char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]460</pre>
461
462<p>A description of each parameter follows:</p></ol>
463
464<h5>pattern</h5>
465<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
466
467<h5>number_fonts</h5>
468<ol><p>Returns the number of fonts in the list.</p></ol>
469
470
471 </div>
472<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
473_8c.html" target="source" name="MagickQueryFonts">MagickQueryFonts</a></h2>
474<div class="doc-section">
475
476<p>MagickQueryFonts() returns any image formats that match the specified pattern (e.g. "*" for all).</p></ol>
477
478<p>The format of the MagickQueryFonts function is:</p>
479
480<pre class="text">
481 char **MagickQueryFonts(const char *pattern,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]482 size_t *number_formats)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]483</pre>
484
485<p>A description of each parameter follows:</p></ol>
486
487<h5>pattern</h5>
488<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
489
490<h5>number_formats</h5>
491<ol><p>This integer returns the number of image formats in the list.</p></ol>
492
493 </div>
494<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
495_8c.html" target="source" name="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
496<div class="doc-section">
497
498<p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p></ol>
499
500<p>The format of the MagickRelinquishMemory method is:</p>
501
502<pre class="code">
503 void *MagickRelinquishMemory(void *resource)
504</pre>
505
506<p>A description of each parameter follows:</p></ol>
507
508<h5>resource</h5>
509<ol><p>Relinquish the memory associated with this resource.</p></ol>
510
511 </div>
512<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
513_8c.html" target="source" name="MagickResetIterator">MagickResetIterator</a></h2>
514<div class="doc-section">
515
516<p>MagickResetIterator() resets the wand iterator. Use it in conjunction with MagickNextImage() to iterate over all the images in a wand container.</p></ol>
517
518<p>The format of the MagickResetIterator method is:</p>
519
520<pre class="code">
521 void MagickResetIterator(MagickWand *wand)
522</pre>
523
524<p>A description of each parameter follows:</p></ol>
525
526<h5>wand</h5>
527<ol><p>the magick wand.</p></ol>
528
529 </div>
530<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
531_8c.html" target="source" name="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
532<div class="doc-section">
533
534<p>MagickSetFirstIterator() sets the wand iterator to the first image.</p></ol>
535
536<p>The format of the MagickSetFirstIterator method is:</p>
537
538<pre class="code">
539 void MagickSetFirstIterator(MagickWand *wand)
540</pre>
541
542<p>A description of each parameter follows:</p></ol>
543
544<h5>wand</h5>
545<ol><p>the magick wand.</p></ol>
546
547 </div>
548<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
549_8c.html" target="source" name="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
550<div class="doc-section">
551
552<p>MagickSetIteratorIndex() set the iterator to the position in the image list specified with the index parameter.</p></ol>
553
554<p>The format of the MagickSetIteratorIndex method is:</p>
555
556<pre class="code">
557 MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]558 const ssize_t index)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]559</pre>
560
561<p>A description of each parameter follows:</p></ol>
562
563<h5>wand</h5>
564<ol><p>the magick wand.</p></ol>
565
566<h5>index</h5>
567<ol><p>the scene number.</p></ol>
568
569 </div>
570<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
571_8c.html" target="source" name="MagickSetLastIterator">MagickSetLastIterator</a></h2>
572<div class="doc-section">
573
574<p>MagickSetLastIterator() sets the wand iterator to the last image.</p></ol>
575
576<p>The format of the MagickSetLastIterator method is:</p>
577
578<pre class="code">
579 void MagickSetLastIterator(MagickWand *wand)
580</pre>
581
582<p>A description of each parameter follows:</p></ol>
583
584<h5>wand</h5>
585<ol><p>the magick wand.</p></ol>
586
587 </div>
588<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
589_8c.html" target="source" name="MagickWandGenesis">MagickWandGenesis</a></h2>
590<div class="doc-section">
591
592<p>MagickWandGenesis() initializes the MagickWand environment.</p></ol>
593
594<p>The format of the MagickWandGenesis method is:</p>
595
596<pre class="code">
597 void MagickWandGenesis(void)
598</pre>
599
600 </div>
601<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
602_8c.html" target="source" name="MagickWandTerminus">MagickWandTerminus</a></h2>
603<div class="doc-section">
604
605<p>MagickWandTerminus() terminates the MagickWand environment.</p></ol>
606
607<p>The format of the MaickWandTerminus method is:</p>
608
609<pre class="code">
610 void MagickWandTerminus(void)
611</pre>
612
613 </div>
614<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
615_8c.html" target="source" name="NewMagickWand">NewMagickWand</a></h2>
616<div class="doc-section">
617
618<p>NewMagickWand() returns a wand required for all other methods in the API.</p></ol>
619
620<p>The format of the NewMagickWand method is:</p>
621
622<pre class="code">
623 MagickWand *NewMagickWand(void)
624</pre>
625
626 </div>
627<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand
628_8c.html" target="source" name="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
629<div class="doc-section">
630
631<p>NewMagickWandFromImage() returns a wand with an image.</p></ol>
632
633<p>The format of the NewMagickWandFromImage method is:</p>
634
635<pre class="code">
636 MagickWand *NewMagickWandFromImage(const Image *image)
637</pre>
638
639<p>A description of each parameter follows:</p></ol>
640
641<h5>image</h5>
642<ol><p>the image.</p></ol>
643
644 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]645
646</div>
647
648<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]649 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]650 <span id="linkbar-center">
651 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]652 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]653 </span>
654 <span id="linkbar-east">&nbsp;</span>
655 </div>
656 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]657 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]658 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
659 </div>
660 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]661 <script type="text/javascript">
662 var _gaq = _gaq || [];
663 _gaq.push(['_setAccount', 'UA-17690367-1']);
664 _gaq.push(['_trackPageview']);
665
666 (function() {
667 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
668 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
669 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
670 })();
671 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]672</body>
673</html>