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