Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 751980dac8acbf24b155ae0d3b45fdf4c452f55c / . / www / api / magick-wand.html
blob: 5c97b33f010f26019327cf80705f4e1206647d9e [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html version="-//W3C//DTD XHTML 1.1//EN"
xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.w3.org/1999/xhtml
http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
<meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
<title>ImageMagick: MagickWand, C API for ImageMagick: Wand Methods</title>
<meta http-equiv="content-language" content="en-US"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta http-equiv="reply-to" content="magick-users@imagemagick.org"/>
<meta name="application-name" content="ImageMagick"/>
<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."/>
<meta name="application-url" content="http://www.imagemagick.org"/>
<meta name="generator" content="PHP"/>
<meta name="keywords" content="magickwc, api, for, imagemagick:, wmethods, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
<meta name="rating" content="GENERAL"/>
<meta name="robots" content="INDEX, FOLLOW"/>
<meta name="generator" content="ImageMagick Studio LLC"/>
<meta name="author" content="ImageMagick Studio LLC"/>
<meta name="revisit-after" content="2 DAYS"/>
<meta name="resource-type" content="document"/>
<meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
<meta name="distribution" content="Global"/>
<link rel="icon" href="../../../../../../../../../../../../../../../../images/wand.png"/>
<link rel="shortcut icon" href="../../../../../../../../../../../../../../../../images/wand.ico" type="images/x-icon"/>
<link rel="canonical" href="http://www.imagemagick.org" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
<!-- Add jQuery library -->
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
<!-- Optionaly include easing and/or mousewheel plugins -->
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
<!-- Add fancyBox -->
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
<!-- Optionaly include button and/or thumbnail helpers -->
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
<script type="text/javascript">
$(document).ready(function() {
$(".fancybox").fancybox();
});
</script>
<!-- ImageMagick style -->
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
<style type="text/css" media="all">
@import url("../../../../../../../../../../../../../../../../www/magick.css");
</style>
</head>
<body id="www-imagemagick-org">
<div class="titlebar">
<div style="margin: 17px auto; float: left;">
<script type="text/javascript">
<!--
google_ad_client = "pub-3129977114552745";
google_ad_slot = "5439289906";
google_ad_width = 728;
google_ad_height = 90;
//-->
</script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</div>
<a href="../../../../../../../../../../../../../../../../discourse-server">
<img src="../../../../../../../../../../../../../../../../images/logo.jpg"
alt="ImageMagick Logo"
style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
<a href="../../../../../../../../../../../../../../../../index.html">
<img src="../../../../../../../../../../../../../../../../images/sprite.jpg"
alt="ImageMagick Sprite"
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
</div>
<div class="westbar">
<div class="menu">
<a title="About ImageMagick" href="../../../../../../../../../../../../../../../../index.html">About ImageMagick</a>
</div>
<div class="menu">
<a title="Binary Releases" href="../../../../../../../../../../../../../../../../www/binary-releases.html">Binary Releases</a>
</div>
<div class="sub">
<a title="Binary Release: Unix" href="../../../../../../../../../../../../../../../../www/binary-releases.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Binary Release: MacOS X" href="../../../../../../../../../../../../../../../../www/binary-releases.html#macosx">Mac OS X</a>
</div>
<div class="sub">
<a title="Binary Release: iOS" href="../../../../../../../../../../../../../../../../www/binary-releases.html#iOS">iOS</a>
</div>
<div class="sub">
<a title="Binary Release: Windows" href="../../../../../../../../../../../../../../../../www/binary-releases.html#windows">Windows</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Command-line Tools" href="../../../../../../../../../../../../../../../../www/command-line-tools.html">Command-line Tools</a>
</div>
<div class="sub">
<a title="Command-line Tools: Processing" href="../../../../../../../../../../../../../../../../www/command-line-processing.html">Processing</a>
</div>
<div class="sub">
<a title="Command-line Tools: Options" href="../../../../../../../../../../../../../../../../www/command-line-options.html">Options</a>
</div>
<div class="sub">
<a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
</div>
<div class="menu">
<a title="Program Interfaces" href="../../../../../../../../../../../../../../../../www/api.html">Program Interfaces</a>
</div>
<div class="sub">
<a title="Program Interface: MagickWand" href="../../../../../../../../../../../../../../../../www/magick-wand.html">MagickWand</a>
</div>
<div class="sub">
<a title="Program Interface: MagickCore" href="../../../../../../../../../../../../../../../../www/magick-core.html">MagickCore</a>
</div>
<div class="sub">
<a title="Program Interface: PerlMagick" href="../../../../../../../../../../../../../../../../www/perl-magick.html">PerlMagick</a>
</div>
<div class="sub">
<a title="Program Interface: Magick++" href="../../../../../../../../../../../../../../../../www/magick++.html">Magick++</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Install from Source" href="../../../../../../../../../../../../../../../../www/install-source.html">Install from Source</a>
</div>
<div class="sub">
<a title="Install from Source: Unix" href="../../../../../../../../../../../../../../../../www/install-source.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Install from Source: Windows" href="../../../../../../../../../../../../../../../../www/install-source.html#windows">Windows</a>
</div>
<div class="menu">
<a title="Resources" href="../../../../../../../../../../../../../../../../www/resources.html">Resources</a>
</div>
<div class="menu">
<a title="Architecture" href="../../../../../../../../../../../../../../../../www/architecture.html">Architecture</a>
</div>
<div class="menu">
<a title="Download" href="../../../../../../../../../../../../../../../../www/download.html">Download</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Search" href="../../../../../../../../../../../../../../../../www/search.html">Search</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Site Map" href="../../../../../../../../../../../../../../../../www/sitemap.html">Site Map</a>
</div>
<div class="sub">
<a title="Site Map: Links" href="../../../../../../../../../../../../../../../../www/links.html">Links</a>
</div>
<div class="sep"></div>
<div class="menu">
<a rel="follow" title="Sponsors" href="../../../../../../../../../../../../../../../../www/sponsors.html">Sponsors:</a>
<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>
<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><!-- 201208010120 mickey@163... -->
<div class="sponsbox">
<div class="sponsor">
<a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
</div>
<div class="sponsor">
<a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
</div>
<div class="sponsor">
<a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
</div>
<div class="sponsor">
<a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Kaffeemaschinen reparatur" href="http://www.kaffeemaschinen-reparatur.de">Kaffeemaschinen reparatur</a><!-- 2012080100030 Temurbas atlas-multimedia-->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Fototapete - Tapetendruck" href="http://www.druck-expert.com/Fototapete-Tapetendruck,category,8830.html">Fototapete - Tapetendruck</a><!-- 2012100100155 info@druck-->
</div>
</div>
</div>
</div>
<div class="eastbar">
<div class="g-plusone" id="gplusone"></div>
<script type="text/javascript">
window.___gcfg = {
lang: 'en-US'
};
(function() {
var po = document.createElement('script');
po.type = 'text/javascript'; po.async = true;
po.src = 'https://apis.google.com/js/plusone.js';
var script = document.getElementsByTagName('script')[0];
script.parentNode.insertBefore(po, script);
})();
var gplusone = document.getElementById("gplusone");
gplusone.setAttribute("data-size","medium");
gplusone.setAttribute("data-count","false");
</script>
</div>
<div class="main">
<h1>Module magick-wand Methods</h1>
<p class="navigation-index">[<a href="magick-wand.html#ClearMagickWand">ClearMagickWand</a> &bull; <a href="magick-wand.html#CloneMagickWand">CloneMagickWand</a> &bull; <a href="magick-wand.html#DestroyMagickWand">DestroyMagickWand</a> &bull; <a href="magick-wand.html#IsMagickWand">IsMagickWand</a> &bull; <a href="magick-wand.html#MagickClearException">MagickClearException</a> &bull; <a href="magick-wand.html#MagickGetException">MagickGetException</a> &bull; <a href="magick-wand.html#MagickGetExceptionType">MagickGetExceptionType</a> &bull; <a href="magick-wand.html#MagickGetIteratorIndex">MagickGetIteratorIndex</a> &bull; <a href="magick-wand.html#MagickQueryConfigureOption">MagickQueryConfigureOption</a> &bull; <a href="magick-wand.html#MagickQueryConfigureOptions">MagickQueryConfigureOptions</a> &bull; <a href="magick-wand.html#MagickQueryFontMetrics">MagickQueryFontMetrics</a> &bull; <a href="magick-wand.html#MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a> &bull; <a href="magick-wand.html#MagickQueryFonts">MagickQueryFonts</a> &bull; <a href="magick-wand.html#MagickQueryFonts">MagickQueryFonts</a> &bull; <a href="magick-wand.html#MagickRelinquishMemory">MagickRelinquishMemory</a> &bull; <a href="magick-wand.html#MagickResetIterator">MagickResetIterator</a> &bull; <a href="magick-wand.html#MagickSetFirstIterator">MagickSetFirstIterator</a> &bull; <a href="magick-wand.html#MagickSetIteratorIndex">MagickSetIteratorIndex</a> &bull; <a href="magick-wand.html#MagickSetLastIterator">MagickSetLastIterator</a> &bull; <a href="magick-wand.html#MagickWandGenesis">MagickWandGenesis</a> &bull; <a href="magick-wand.html#MagickWandTerminus">MagickWandTerminus</a> &bull; <a href="magick-wand.html#NewMagickWand">NewMagickWand</a> &bull; <a href="magick-wand.html#NewMagickWandFromImage">NewMagickWandFromImage</a>]</p>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="ClearMagickWand">ClearMagickWand</a></h2>
<div class="doc-section">
<p>ClearMagickWand() clears resources associated with the wand, leaving the wand blank, and ready to be used for a new set of images.</p>
<p>The format of the ClearMagickWand method is:</p>
<pre class="code">
void ClearMagickWand(MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the magick wand.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="CloneMagickWand">CloneMagickWand</a></h2>
<div class="doc-section">
<p>CloneMagickWand() makes an exact copy of the specified wand.</p>
<p>The format of the CloneMagickWand method is:</p>
<pre class="code">
MagickWand *CloneMagickWand(const MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the magick wand.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="DestroyMagickWand">DestroyMagickWand</a></h2>
<div class="doc-section">
<p>DestroyMagickWand() deallocates memory associated with an MagickWand.</p>
<p>The format of the DestroyMagickWand method is:</p>
<pre class="code">
MagickWand *DestroyMagickWand(MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the magick wand.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="IsMagickWand">IsMagickWand</a></h2>
<div class="doc-section">
<p>IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.</p>
<p>The format of the IsMagickWand method is:</p>
<pre class="code">
MagickBooleanType IsMagickWand(const MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the magick wand.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickClearException">MagickClearException</a></h2>
<div class="doc-section">
<p>MagickClearException() clears any exceptions associated with the wand.</p>
<p>The format of the MagickClearException method is:</p>
<pre class="code">
MagickBooleanType MagickClearException(MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the magick wand.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickGetException">MagickGetException</a></h2>
<div class="doc-section">
<p>MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
<p>The format of the MagickGetException method is:</p>
<pre class="code">
char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the magick wand.</p>
<h5>severity</h5>
<p>the severity of the error is returned here.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickGetExceptionType">MagickGetExceptionType</a></h2>
<div class="doc-section">
<p>MagickGetExceptionType() returns the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p>
<p>The format of the MagickGetExceptionType method is:</p>
<pre class="code">
ExceptionType MagickGetExceptionType(const MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the magick wand.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickGetIteratorIndex">MagickGetIteratorIndex</a></h2>
<div class="doc-section">
<p>MagickGetIteratorIndex() returns the position of the iterator in the image list.</p>
<p>The format of the MagickGetIteratorIndex method is:</p>
<pre class="code">
ssize_t MagickGetIteratorIndex(MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the magick wand.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryConfigureOption">MagickQueryConfigureOption</a></h2>
<div class="doc-section">
<p>MagickQueryConfigureOption() returns the value associated with the specified configure option.</p>
<p>The format of the MagickQueryConfigureOption function is:</p>
<pre class="text">
char *MagickQueryConfigureOption(const char *option)
</pre>
<p>A description of each parameter follows:</p>
<h5>option</h5>
<p>the option name.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryConfigureOptions">MagickQueryConfigureOptions</a></h2>
<div class="doc-section">
<p>MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g. "*" for all). Options include NAME, VERSION, LIB_VERSION, etc.</p>
<p>The format of the MagickQueryConfigureOptions function is:</p>
<pre class="text">
char **MagickQueryConfigureOptions(const char *pattern,
size_t *number_options)
</pre>
<p>A description of each parameter follows:</p>
<h5>pattern</h5>
<p>Specifies a pointer to a text string containing a pattern.</p>
<h5>number_options</h5>
<p>Returns the number of configure options in the list.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryFontMetrics">MagickQueryFontMetrics</a></h2>
<div class="doc-section">
<p>MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:</p>
<pre class="text">
Element Description
-------------------------------------------------
0 character width
1 character height
2 ascender
3 descender
4 text width
5 text height
6 maximum horizontal advance
7 bounding box: x1
8 bounding box: y1
9 bounding box: x2
10 bounding box: y2
11 origin: x
12 origin: y
</pre>
<p>The format of the MagickQueryFontMetrics method is:</p>
<pre class="code">
double *MagickQueryFontMetrics(MagickWand *wand,
const DrawingWand *drawing_wand,const char *text)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the Magick wand.</p>
<h5>drawing_wand</h5>
<p>the drawing wand.</p>
<h5>text</h5>
<p>the text.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryMultilineFontMetrics">MagickQueryMultilineFontMetrics</a></h2>
<div class="doc-section">
<p>MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:</p>
<pre class="text">
Element Description
-------------------------------------------------
0 character width
1 character height
2 ascender
3 descender
4 text width
5 text height
6 maximum horizontal advance
7 bounding box: x1
8 bounding box: y1
9 bounding box: x2
10 bounding box: y2
11 origin: x
12 origin: y
</pre>
<p>This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.</p>
<p>The format of the MagickQueryFontMetrics method is:</p>
<pre class="code">
double *MagickQueryMultilineFontMetrics(MagickWand *wand,
const DrawingWand *drawing_wand,const char *text)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the Magick wand.</p>
<h5>drawing_wand</h5>
<p>the drawing wand.</p>
<h5>text</h5>
<p>the text.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
<div class="doc-section">
<p>MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).</p>
<p>The format of the MagickQueryFonts function is:</p>
<pre class="text">
char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
</pre>
<p>A description of each parameter follows:</p>
<h5>pattern</h5>
<p>Specifies a pointer to a text string containing a pattern.</p>
<h5>number_fonts</h5>
<p>Returns the number of fonts in the list.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickQueryFonts">MagickQueryFonts</a></h2>
<div class="doc-section">
<p>MagickQueryFonts() returns any image formats that match the specified pattern (e.g. "*" for all).</p>
<p>The format of the MagickQueryFonts function is:</p>
<pre class="text">
char **MagickQueryFonts(const char *pattern,
size_t *number_formats)
</pre>
<p>A description of each parameter follows:</p>
<h5>pattern</h5>
<p>Specifies a pointer to a text string containing a pattern.</p>
<h5>number_formats</h5>
<p>This integer returns the number of image formats in the list.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickRelinquishMemory">MagickRelinquishMemory</a></h2>
<div class="doc-section">
<p>MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.</p>
<p>The format of the MagickRelinquishMemory method is:</p>
<pre class="code">
void *MagickRelinquishMemory(void *resource)
</pre>
<p>A description of each parameter follows:</p>
<h5>resource</h5>
<p>Relinquish the memory associated with this resource.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickResetIterator">MagickResetIterator</a></h2>
<div class="doc-section">
<p>MagickResetIterator() resets the wand iterator.</p>
<p>It is typically used either before iterating though images, or before calling specific functions such as MagickAppendImages() to append all images together.</p>
<p>Afterward you can use MagickNextImage() to iterate over all the images in a wand container, starting with the first image.</p>
<p>Using this before MagickAddImages() or MagickReadImages() will cause new images to be inserted between the first and second image.</p>
<p>The format of the MagickResetIterator method is:</p>
<pre class="code">
void MagickResetIterator(MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the magick wand.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickSetFirstIterator">MagickSetFirstIterator</a></h2>
<div class="doc-section">
<p>MagickSetFirstIterator() sets the wand iterator to the first image.</p>
<p>After using any images added to the wand using MagickAddImage() or MagickReadImage() will be prepended before any image in the wand.</p>
<p>Also the current image has been set to the first image (if any) in the Magick Wand. Using MagickNextImage() will then set teh current image to the second image in the list (if present).</p>
<p>This operation is similar to MagickResetIterator() but differs in how MagickAddImage(), MagickReadImage(), and MagickNextImage() behaves afterward.</p>
<p>The format of the MagickSetFirstIterator method is:</p>
<pre class="code">
void MagickSetFirstIterator(MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the magick wand.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickSetIteratorIndex">MagickSetIteratorIndex</a></h2>
<div class="doc-section">
<p>MagickSetIteratorIndex() set the iterator to the given position in the image list specified with the index parameter. A zero index will set the first image as current, and so on. Negative indexes can be used to specify an image relative to the end of the images in the wand, with -1 being the last image in the wand.</p>
<p>If the index is invalid (range too large for number of images in wand) the function will return MagickFalse, but no 'exception' will be raised, as it is not actually an error. In that case the current image will not change.</p>
<p>After using any images added to the wand using MagickAddImage() or MagickReadImage() will be added after the image indexed, regardless of if a zero (first image in list) or negative index (from end) is used.</p>
<p>Jumping to index 0 is similar to MagickResetIterator() but differs in how MagickNextImage() behaves afterward.</p>
<p>The format of the MagickSetIteratorIndex method is:</p>
<pre class="code">
MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
const ssize_t index)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the magick wand.</p>
<h5>index</h5>
<p>the scene number.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickSetLastIterator">MagickSetLastIterator</a></h2>
<div class="doc-section">
<p>MagickSetLastIterator() sets the wand iterator to the last image.</p>
<p>The last image is actually the current image, and the next use of MagickPreviousImage() will not change this allowing this function to be used to iterate over the images in the reverse direction. In this sense it is more like MagickResetIterator() than MagickSetFirstIterator().</p>
<p>Typically this function is used before MagickAddImage(), MagickReadImage() functions to ensure new images are appended to the very end of wand's image list.</p>
<p>The format of the MagickSetLastIterator method is:</p>
<pre class="code">
void MagickSetLastIterator(MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p>
<h5>wand</h5>
<p>the magick wand.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickWandGenesis">MagickWandGenesis</a></h2>
<div class="doc-section">
<p>MagickWandGenesis() initializes the MagickWand environment.</p>
<p>The format of the MagickWandGenesis method is:</p>
<pre class="code">
void MagickWandGenesis(void)
</pre>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="MagickWandTerminus">MagickWandTerminus</a></h2>
<div class="doc-section">
<p>MagickWandTerminus() terminates the MagickWand environment.</p>
<p>The format of the MaickWandTerminus method is:</p>
<pre class="code">
void MagickWandTerminus(void)
</pre>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="NewMagickWand">NewMagickWand</a></h2>
<div class="doc-section">
<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>
<p>The format of the NewMagickWand method is:</p>
<pre class="code">
MagickWand *NewMagickWand(void)
</pre>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickWand/magick-wand_8c.html" id="NewMagickWandFromImage">NewMagickWandFromImage</a></h2>
<div class="doc-section">
<p>NewMagickWandFromImage() returns a wand with an image.</p>
<p>The format of the NewMagickWandFromImage method is:</p>
<pre class="code">
MagickWand *NewMagickWandFromImage(const Image *image)
</pre>
<p>A description of each parameter follows:</p>
<h5>image</h5>
<p>the image.</p>
</div>
</div>
<div id="linkbar">
<span id="linkbar-west">&nbsp;</span>
<span id="linkbar-center">
<a href="../../../../../../../../../../../../../../../../discourse-server">Discourse Server</a> &bull;
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
</span>
<span id="linkbar-east">&nbsp;</span>
</div>
<div class="footer">
<span id="footer-west">&copy; 1999-2012 ImageMagick Studio LLC</span>
<span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-17690367-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>