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