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