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