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