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