blob: d3f94b2255aa6f66a684db14d1b57f6b05309075 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +00001<!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 +00004<head>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +00007 <title>ImageMagick: MagickWand, C API for ImageMagick: Wand Methods</title>
cristy3ed852e2009-09-05 21:47:34 +00008 <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 +000011 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +000012 <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 +000013 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000014 <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 +000016 <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 +000022 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000023 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000024 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000025 <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"/>
cristy7a40ba82011-01-08 20:31:18 +000027 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000028 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +000031 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000032 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000044</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +000053 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000054<a href="http://www.imagemagick.org/discourse-server/">
55 <img src="../../images/logo.jpg" alt=""
cristy178edaf2011-01-23 03:42:39 +000056 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000057<a href="../../index.html">
58 <img src="../../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
cristyce69bb02010-07-27 19:49:46 +000062<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000063
cristy3ed852e2009-09-05 21:47:34 +000064<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000065 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000066</div>
cristy3eaa0ef2010-03-06 20:35:26 +000067<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000068<div class="menu">
cristybb503372010-05-27 20:51:26 +000069 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000082 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000083</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000085 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000086</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000088 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000089</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000091 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000092</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000094 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000095</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000098</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000106 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000110 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000113 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristybb503372010-05-27 20:51:26 +0000121<div class="menu">
122 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000125 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000128<div class="menu">
cristy52923442011-01-15 22:54:31 +0000129 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000133 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000136 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000140 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000141
142<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000143<div class="sponsor">
144 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
145</div>
cristyec6b4752011-01-08 03:16:23 +0000146<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000147 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy73fd1cd2010-09-12 19:14:25 +0000148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000155<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000156 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
157</div>
158<div class="sponsor">
cristyc7a6e3e2011-01-26 16:54:03 +0000159 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011050100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000160</div>
cristy96e13132010-06-07 14:55:44 +0000161</div>
cristy3ed852e2009-09-05 21:47:34 +0000162</div>
cristyce69bb02010-07-27 19:49:46 +0000163</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000164
cristyce69bb02010-07-27 19:49:46 +0000165<div class="eastbar">
166 <script type="text/javascript">
167 <!--
168 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000169 google_ad_slot = "0574824969";
170 google_ad_width = 160;
171 google_ad_height = 600;
172 //-->
173 </script>
174 <script type="text/javascript"
175 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
176 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000177</div>
178
179<div class="main">
180
cristy307ba182010-12-25 01:00:34 +0000181<h1>Module magick-wand
182 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000183<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>
184
cristy7a40ba82011-01-08 20:31:18 +0000185<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
186_8c.html" id="ClearMagickWand">ClearMagickWand</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000187<div class="doc-section">
188
cristy7a40ba82011-01-08 20:31:18 +0000189<p>ClearMagickWand() clears resources associated with the wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000190
191<p>The format of the ClearMagickWand method is:</p>
192
193<pre class="code">
194 void ClearMagickWand(MagickWand *wand)
195</pre>
196
cristy7a40ba82011-01-08 20:31:18 +0000197<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000198
199<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000200<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000201
202 </div>
cristy7a40ba82011-01-08 20:31:18 +0000203<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
204_8c.html" id="CloneMagickWand">CloneMagickWand</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000205<div class="doc-section">
206
cristy7a40ba82011-01-08 20:31:18 +0000207<p>CloneMagickWand() makes an exact copy of the specified wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000208
209<p>The format of the CloneMagickWand method is:</p>
210
211<pre class="code">
212 MagickWand *CloneMagickWand(const MagickWand *wand)
213</pre>
214
cristy7a40ba82011-01-08 20:31:18 +0000215<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000216
217<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000218<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000219
220 </div>
cristy7a40ba82011-01-08 20:31:18 +0000221<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
222_8c.html" id="DestroyMagickWand">DestroyMagickWand</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000223<div class="doc-section">
224
cristy7a40ba82011-01-08 20:31:18 +0000225<p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000226
227<p>The format of the DestroyMagickWand method is:</p>
228
229<pre class="code">
230 MagickWand *DestroyMagickWand(MagickWand *wand)
231</pre>
232
cristy7a40ba82011-01-08 20:31:18 +0000233<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000234
235<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000236<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000237
238 </div>
cristy7a40ba82011-01-08 20:31:18 +0000239<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
240_8c.html" id="IsMagickWand">IsMagickWand</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000241<div class="doc-section">
242
cristy7a40ba82011-01-08 20:31:18 +0000243<p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000244
245<p>The format of the IsMagickWand method is:</p>
246
247<pre class="code">
248 MagickBooleanType IsMagickWand(const MagickWand *wand)
249</pre>
250
cristy7a40ba82011-01-08 20:31:18 +0000251<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000252
253<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000254<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000255
256 </div>
cristy7a40ba82011-01-08 20:31:18 +0000257<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
258_8c.html" id="MagickClearException">MagickClearException</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000259<div class="doc-section">
260
cristy7a40ba82011-01-08 20:31:18 +0000261<p>MagickClearException() clears any exceptions associated with the wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000262
263<p>The format of the MagickClearException method is:</p>
264
265<pre class="code">
266 MagickBooleanType MagickClearException(MagickWand *wand)
267</pre>
268
cristy7a40ba82011-01-08 20:31:18 +0000269<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000270
271<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000272<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000273
274 </div>
cristy7a40ba82011-01-08 20:31:18 +0000275<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
276_8c.html" id="MagickGetException">MagickGetException</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000277<div class="doc-section">
278
cristy7a40ba82011-01-08 20:31:18 +0000279<p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
cristy3ed852e2009-09-05 21:47:34 +0000280
281<p>The format of the MagickGetException method is:</p>
282
283<pre class="code">
284 char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
285</pre>
286
cristy7a40ba82011-01-08 20:31:18 +0000287<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000288
289<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000290<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000291
292<h5>severity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000293<p>the severity of the error is returned here.</p>
cristy3ed852e2009-09-05 21:47:34 +0000294
295 </div>
cristy7a40ba82011-01-08 20:31:18 +0000296<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
297_8c.html" id="MagickGetExceptionType">MagickGetExceptionType</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000298<div class="doc-section">
299
cristy7a40ba82011-01-08 20:31:18 +0000300<p>MagickGetExceptionType() returns the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p>
cristy3ed852e2009-09-05 21:47:34 +0000301
302<p>The format of the MagickGetExceptionType method is:</p>
303
304<pre class="code">
305 ExceptionType MagickGetExceptionType(const MagickWand *wand)
306</pre>
307
cristy7a40ba82011-01-08 20:31:18 +0000308<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000309
310<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000311<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000312
313 </div>
cristy7a40ba82011-01-08 20:31:18 +0000314<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
315_8c.html" id="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000316<div class="doc-section">
317
cristy7a40ba82011-01-08 20:31:18 +0000318<p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000319
320<p>The format of the MagickGetIteratorIndex method is:</p>
321
322<pre class="code">
cristybb503372010-05-27 20:51:26 +0000323 ssize_t MagickGetIteratorIndex(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000324</pre>
325
cristy7a40ba82011-01-08 20:31:18 +0000326<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000327
328<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000329<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000330
331 </div>
cristy7a40ba82011-01-08 20:31:18 +0000332<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
333_8c.html" id="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000334<div class="doc-section">
335
cristy7a40ba82011-01-08 20:31:18 +0000336<p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p>
cristy3ed852e2009-09-05 21:47:34 +0000337
338<p>The format of the MagickQueryConfigureOption function is:</p>
339
340<pre class="text">
341 char *MagickQueryConfigureOption(const char *option)
342</pre>
343
cristy7a40ba82011-01-08 20:31:18 +0000344<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000345
346<h5>option</h5>
cristy7a40ba82011-01-08 20:31:18 +0000347<p>the option name.</p>
cristy3ed852e2009-09-05 21:47:34 +0000348
349 </div>
cristy7a40ba82011-01-08 20:31:18 +0000350<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
351_8c.html" id="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000352<div class="doc-section">
353
cristy7a40ba82011-01-08 20:31:18 +0000354<p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g. "*" for all). Options include NAME, VERSION, LIB_VERSION, etc.</p>
cristy3ed852e2009-09-05 21:47:34 +0000355
356<p>The format of the MagickQueryConfigureOptions function is:</p>
357
358<pre class="text">
359 char **MagickQueryConfigureOptions(const char *pattern,
cristybb503372010-05-27 20:51:26 +0000360 size_t *number_options)
cristy3ed852e2009-09-05 21:47:34 +0000361</pre>
362
cristy7a40ba82011-01-08 20:31:18 +0000363<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000364
365<h5>pattern</h5>
cristy7a40ba82011-01-08 20:31:18 +0000366<p>Specifies a pointer to a text string containing a pattern.</p>
cristy3ed852e2009-09-05 21:47:34 +0000367
368<h5>number_options</h5>
cristy7a40ba82011-01-08 20:31:18 +0000369<p>Returns the number of configure options in the list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000370
371
372 </div>
cristy7a40ba82011-01-08 20:31:18 +0000373<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
374_8c.html" id="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000375<div class="doc-section">
376
377<p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
378
379<pre class="text">
380 Element Description
381 -------------------------------------------------
382 0 character width
383 1 character height
384 2 ascender
385 3 descender
386 4 text width
387 5 text height
388 6 maximum horizontal advance
389 7 bounding box: x1
390 8 bounding box: y1
391 9 bounding box: x2
392 10 bounding box: y2
393 11 origin: x
394 12 origin: y
395</pre>
396
397<p>The format of the MagickQueryFontMetrics method is:</p>
398
399<pre class="code">
400 double *MagickQueryFontMetrics(MagickWand *wand,
401 const DrawingWand *drawing_wand,const char *text)
402</pre>
403
cristy7a40ba82011-01-08 20:31:18 +0000404<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000405
406<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000407<p>the Magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000408
409<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000410<p>the drawing wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000411
412<h5>text</h5>
cristy7a40ba82011-01-08 20:31:18 +0000413<p>the text.</p>
cristy3ed852e2009-09-05 21:47:34 +0000414
415 </div>
cristy7a40ba82011-01-08 20:31:18 +0000416<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
417_8c.html" id="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000418<div class="doc-section">
419
420<p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
421
422<pre class="text">
423 Element Description
424 -------------------------------------------------
425 0 character width
426 1 character height
427 2 ascender
428 3 descender
429 4 text width
430 5 text height
431 6 maximum horizontal advance
432 7 bounding box: x1
433 8 bounding box: y1
434 9 bounding box: x2
435 10 bounding box: y2
436 11 origin: x
437 12 origin: y
438</pre>
439
cristy7a40ba82011-01-08 20:31:18 +0000440<p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
cristy3ed852e2009-09-05 21:47:34 +0000441
442<p>The format of the MagickQueryFontMetrics method is:</p>
443
444<pre class="code">
445 double *MagickQueryMultilineFontMetrics(MagickWand *wand,
446 const DrawingWand *drawing_wand,const char *text)
447</pre>
448
cristy7a40ba82011-01-08 20:31:18 +0000449<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000450
451<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000452<p>the Magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000453
454<h5>drawing_wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000455<p>the drawing wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000456
457<h5>text</h5>
cristy7a40ba82011-01-08 20:31:18 +0000458<p>the text.</p>
cristy3ed852e2009-09-05 21:47:34 +0000459
460 </div>
cristy7a40ba82011-01-08 20:31:18 +0000461<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
462_8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000463<div class="doc-section">
464
cristy7a40ba82011-01-08 20:31:18 +0000465<p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p>
cristy3ed852e2009-09-05 21:47:34 +0000466
467<p>The format of the MagickQueryFonts function is:</p>
468
469<pre class="text">
cristybb503372010-05-27 20:51:26 +0000470 char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
cristy3ed852e2009-09-05 21:47:34 +0000471</pre>
472
cristy7a40ba82011-01-08 20:31:18 +0000473<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000474
475<h5>pattern</h5>
cristy7a40ba82011-01-08 20:31:18 +0000476<p>Specifies a pointer to a text string containing a pattern.</p>
cristy3ed852e2009-09-05 21:47:34 +0000477
478<h5>number_fonts</h5>
cristy7a40ba82011-01-08 20:31:18 +0000479<p>Returns the number of fonts in the list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000480
481
482 </div>
cristy7a40ba82011-01-08 20:31:18 +0000483<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
484_8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000485<div class="doc-section">
486
cristy7a40ba82011-01-08 20:31:18 +0000487<p>MagickQueryFonts() returns any image formats that match the specified pattern (e.g. "*" for all).</p>
cristy3ed852e2009-09-05 21:47:34 +0000488
489<p>The format of the MagickQueryFonts function is:</p>
490
491<pre class="text">
492 char **MagickQueryFonts(const char *pattern,
cristybb503372010-05-27 20:51:26 +0000493 size_t *number_formats)
cristy3ed852e2009-09-05 21:47:34 +0000494</pre>
495
cristy7a40ba82011-01-08 20:31:18 +0000496<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000497
498<h5>pattern</h5>
cristy7a40ba82011-01-08 20:31:18 +0000499<p>Specifies a pointer to a text string containing a pattern.</p>
cristy3ed852e2009-09-05 21:47:34 +0000500
501<h5>number_formats</h5>
cristy7a40ba82011-01-08 20:31:18 +0000502<p>This integer returns the number of image formats in the list.</p>
cristy3ed852e2009-09-05 21:47:34 +0000503
504 </div>
cristy7a40ba82011-01-08 20:31:18 +0000505<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
506_8c.html" id="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000507<div class="doc-section">
508
cristy7a40ba82011-01-08 20:31:18 +0000509<p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p>
cristy3ed852e2009-09-05 21:47:34 +0000510
511<p>The format of the MagickRelinquishMemory method is:</p>
512
513<pre class="code">
514 void *MagickRelinquishMemory(void *resource)
515</pre>
516
cristy7a40ba82011-01-08 20:31:18 +0000517<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000518
519<h5>resource</h5>
cristy7a40ba82011-01-08 20:31:18 +0000520<p>Relinquish the memory associated with this resource.</p>
cristy3ed852e2009-09-05 21:47:34 +0000521
522 </div>
cristy7a40ba82011-01-08 20:31:18 +0000523<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
524_8c.html" id="MagickResetIterator">MagickResetIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000525<div class="doc-section">
526
cristy7a40ba82011-01-08 20:31:18 +0000527<p>MagickResetIterator() resets the wand iterator. Use it in conjunction with MagickNextImage() to iterate over all the images in a wand container.</p>
cristy3ed852e2009-09-05 21:47:34 +0000528
529<p>The format of the MagickResetIterator method is:</p>
530
531<pre class="code">
532 void MagickResetIterator(MagickWand *wand)
533</pre>
534
cristy7a40ba82011-01-08 20:31:18 +0000535<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000536
537<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000538<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000539
540 </div>
cristy7a40ba82011-01-08 20:31:18 +0000541<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
542_8c.html" id="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000543<div class="doc-section">
544
cristy7a40ba82011-01-08 20:31:18 +0000545<p>MagickSetFirstIterator() sets the wand iterator to the first image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000546
547<p>The format of the MagickSetFirstIterator method is:</p>
548
549<pre class="code">
550 void MagickSetFirstIterator(MagickWand *wand)
551</pre>
552
cristy7a40ba82011-01-08 20:31:18 +0000553<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000554
555<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000556<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000557
558 </div>
cristy7a40ba82011-01-08 20:31:18 +0000559<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
560_8c.html" id="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000561<div class="doc-section">
562
cristy7a40ba82011-01-08 20:31:18 +0000563<p>MagickSetIteratorIndex() set the iterator to the position in the image list specified with the index parameter.</p>
cristy3ed852e2009-09-05 21:47:34 +0000564
565<p>The format of the MagickSetIteratorIndex method is:</p>
566
567<pre class="code">
568 MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
cristybb503372010-05-27 20:51:26 +0000569 const ssize_t index)
cristy3ed852e2009-09-05 21:47:34 +0000570</pre>
571
cristy7a40ba82011-01-08 20:31:18 +0000572<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000573
574<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000575<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000576
577<h5>index</h5>
cristy7a40ba82011-01-08 20:31:18 +0000578<p>the scene number.</p>
cristy3ed852e2009-09-05 21:47:34 +0000579
580 </div>
cristy7a40ba82011-01-08 20:31:18 +0000581<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
582_8c.html" id="MagickSetLastIterator">MagickSetLastIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000583<div class="doc-section">
584
cristy7a40ba82011-01-08 20:31:18 +0000585<p>MagickSetLastIterator() sets the wand iterator to the last image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000586
587<p>The format of the MagickSetLastIterator method is:</p>
588
589<pre class="code">
590 void MagickSetLastIterator(MagickWand *wand)
591</pre>
592
cristy7a40ba82011-01-08 20:31:18 +0000593<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000594
595<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000596<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000597
598 </div>
cristy7a40ba82011-01-08 20:31:18 +0000599<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
600_8c.html" id="MagickWandGenesis">MagickWandGenesis</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000601<div class="doc-section">
602
cristy7a40ba82011-01-08 20:31:18 +0000603<p>MagickWandGenesis() initializes the MagickWand environment.</p>
cristy3ed852e2009-09-05 21:47:34 +0000604
605<p>The format of the MagickWandGenesis method is:</p>
606
607<pre class="code">
608 void MagickWandGenesis(void)
609</pre>
610
611 </div>
cristy7a40ba82011-01-08 20:31:18 +0000612<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
613_8c.html" id="MagickWandTerminus">MagickWandTerminus</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000614<div class="doc-section">
615
cristy7a40ba82011-01-08 20:31:18 +0000616<p>MagickWandTerminus() terminates the MagickWand environment.</p>
cristy3ed852e2009-09-05 21:47:34 +0000617
618<p>The format of the MaickWandTerminus method is:</p>
619
620<pre class="code">
621 void MagickWandTerminus(void)
622</pre>
623
624 </div>
cristy7a40ba82011-01-08 20:31:18 +0000625<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
626_8c.html" id="NewMagickWand">NewMagickWand</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000627<div class="doc-section">
628
cristy7a40ba82011-01-08 20:31:18 +0000629<p>NewMagickWand() returns a wand required for all other methods in the API.</p>
cristy3ed852e2009-09-05 21:47:34 +0000630
631<p>The format of the NewMagickWand method is:</p>
632
633<pre class="code">
634 MagickWand *NewMagickWand(void)
635</pre>
636
637 </div>
cristy7a40ba82011-01-08 20:31:18 +0000638<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/magick-wand
639_8c.html" id="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000640<div class="doc-section">
641
cristy7a40ba82011-01-08 20:31:18 +0000642<p>NewMagickWandFromImage() returns a wand with an image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000643
644<p>The format of the NewMagickWandFromImage method is:</p>
645
646<pre class="code">
647 MagickWand *NewMagickWandFromImage(const Image *image)
648</pre>
649
cristy7a40ba82011-01-08 20:31:18 +0000650<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000651
652<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000653<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000654
655 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000656
657</div>
658
659<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000660 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000661 <span id="linkbar-center">
662 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000663 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000664 </span>
665 <span id="linkbar-east">&nbsp;</span>
666 </div>
667 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000668 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000669 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
670 </div>
671 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000672 <script type="text/javascript">
673 var _gaq = _gaq || [];
674 _gaq.push(['_setAccount', 'UA-17690367-1']);
675 _gaq.push(['_trackPageview']);
676
677 (function() {
678 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
679 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
680 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
681 })();
682 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000683</body>
684</html>