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