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