<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<style type="text/css" media="screen,projection"><!--
@import url("../../www/magick.css");
//--></style>
<meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
<title>ImageMagick: MagickWand, C API for ImageMagick: Pixel Iterator 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="Generator" content="PHP"/>
<meta name="Keywords" content="magickwc, api, for, imagemagick:, pixel, iterator, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject"/>
<meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
<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-2008 ImageMagick Studio LLC"/>
<meta name="Distribution" content="Global"/>
<link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
</head>
<body id="www-imagemagick-org">
<table id="titlebar" style="width: 100%;background-color: #f5f5f5" cellpadding="0" cellspacing="0" border="0" summary="ImageMagick">
<tbody>
<tr valign="top">
<td align="left"><a href="../../index.html"><img id="titlebar-west" src="../../images/script.png" alt="[ImageMagick]" width="350" height="60" border="0" vspace="28" name="titlebar-west"/></a></td>
<td align="left"><a href="https://secure.networkredux.com/affiliate/idevaffiliate.html?id=146" target="870952353"><img id="titlebar-west" src="../../images/networkredux.png" alt="[sponsor]" border="0" vspace="45" name="titlebar-west"/></a></td>
<td width="99%"><br /> </td>
<td style="background-color: white" align="right"><a href="../../index.html"><img src="../../images/sprite.jpg" alt="" width="114" height="118" border="0" name="titlebar-east"/></a></td>
<td style="background-color: white" align="right"><a href="http://www.imagemagick.org/discourse-server/" target="1267935165"><img id="titlebar-east" src="../../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east"/></a></td>
</tr>
</tbody>
</table>
<table style="width: 100%" border="0" cellpadding="0" cellspacing="0" summary="">
<tbody>
<tr valign="top" style="height: 100%;">
<td id="menu" width="1%" height="100%">
<p><a href="#main">Skip to page contents</a></p>
<font size="-1">
<span>[</span>
<a href="../../index.html">About ImageMagick</a>
<span>]</span><br /><span>[</span>
<a href="../../www/command-line-tools.html">Command-line Tools</a>
<a href="../../www/command-line-processing.html" class="sub">Processing</a>
<a href="../../www/command-line-options.html" class="sub">Options</a>
<a href="http://www.imagemagick.org/Usage/" target="1496857272" class="sub">Usage</a>
<a href="../../www/api.html">Program Interfaces</a>
<a href="../../www/magick-wand.html" class="sub">MagickWand</a>
<a href="../../www/magick-core.html" class="sub">MagickCore</a>
<a href="../../www/perl-magick.html" class="sub">PerlMagick</a>
<a href="../../Magick++/" target="1658897613" class="sub">Magick++</a>
<a href="../../www/architecture.html">Architecture</a>
<span>]</span><br /><span>[</span>
<a href="../../www/install-source.html">Install from Source</a>
<a href="../../www/install-source.html#unix" class="sub">Unix</a>
<a href="../../www/install-source.html#windows" class="sub">Windows</a>
<a href="../../www/binary-releases.html">Binary Releases</a>
<a href="../../www/binary-releases.html#unix" class="sub">Unix</a>
<a href="../../www/binary-releases.html#macosx" class="sub">Mac OS X</a>
<a href="../../www/binary-releases.html#windows" class="sub">Windows</a>
<a href="../../www/resources.html">Resources</a>
<span>]</span><br /><span>[</span>
<a href="../../www/download.html">Download</a>
<span>]</span><br /><span>[</span>
<a href="../../www/sitemap.html">Site Map</a>
<a href="../../www/links.html" class="sub">Links</a>
<span>]</span><br /><span>[</span>
<a href="../../www/sponsors.html">Sponsors:</a>
<fieldset>
<a href="http://www.hitflip.co.uk/books/" class="sponsor" target="sponsor">Swap Books</a><!-- 200802010000 -->
<br />
<a href="http://business-directory.com"><img src="../../images/business+directory.gif" alt="[Business + Directory]" width="105" height="60" border="0" name="business+directory"/></a> <!-- 200808010160 -->
<br />
<a href="http://analogik.com"><img src="../../images/analogik.png" alt="[Electronic Music]" width="105" height="60" border="0" name="analogik"/></a> <!-- 200804030160 -->
</fieldset>
<span>]</span>
</font>
</td>
<td id="main" valign="top">
<p class="navigation-index">[ <a href="#ClearPixelIterator">ClearPixelIterator</a> | <a href="#ClonePixelIterator">ClonePixelIterator</a> | <a href="#DestroyPixelIterator">DestroyPixelIterator</a> | <a href="#IsPixelIterator">IsPixelIterator</a> | <a href="#NewPixelIterator">NewPixelIterator</a> | <a href="#PixelClearIteratorException">PixelClearIteratorException</a> | <a href="#NewPixelRegionIterator">NewPixelRegionIterator</a> | <a href="#PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a> | <a href="#PixelGetIteratorException">PixelGetIteratorException</a> | <a href="#PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a> | <a href="#PixelGetIteratorRow">PixelGetIteratorRow</a> | <a href="#PixelGetNextIteratorRow">PixelGetNextIteratorRow</a> | <a href="#PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a> | <a href="#PixelResetIterator">PixelResetIterator</a> | <a href="#PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a> | <a href="#PixelSetIteratorRow">PixelSetIteratorRow</a> | <a href="#PixelSetLastIteratorRow">PixelSetLastIteratorRow</a> | <a href="#PixelSyncIterator">PixelSyncIterator</a> ]</p>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="ClearPixelIterator">ClearPixelIterator</a></h2>
</div>
<p>ClearPixelIterator() clear resources associated with a PixelIterator.</p></ol>
<p>The format of the ClearPixelIterator method is:</p>
<pre class="code">
PixelIterator *ClearPixelIterator(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the pixel iterator.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="ClonePixelIterator">ClonePixelIterator</a></h2>
</div>
<p>ClonePixelIterator() makes an exact copy of the specified iterator.</p></ol>
<p>The format of the ClonePixelIterator method is:</p>
<pre class="code">
PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the magick iterator.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="DestroyPixelIterator">DestroyPixelIterator</a></h2>
</div>
<p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p></ol>
<p>The format of the DestroyPixelIterator method is:</p>
<pre class="code">
PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the pixel iterator.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="IsPixelIterator">IsPixelIterator</a></h2>
</div>
<p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p></ol>
<p>The format of the IsPixelIterator method is:</p>
<pre class="code">
MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the magick iterator.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="NewPixelIterator">NewPixelIterator</a></h2>
</div>
<p>NewPixelIterator() returns a new pixel iterator.</p></ol>
<p>The format of the NewPixelIterator method is:</p>
<pre class="code">
PixelIterator NewPixelIterator(MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>wand</h5>
<ol><p>the magick wand.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="PixelClearIteratorException">PixelClearIteratorException</a></h2>
</div>
<p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p></ol>
<p>The format of the PixelClearIteratorException method is:</p>
<pre class="code">
MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>wand</h5>
<ol><p>the pixel wand.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
</div>
<p>NewPixelRegionIterator() returns a new pixel iterator.</p></ol>
<p>The format of the NewPixelRegionIterator method is:</p>
<pre class="code">
PixelIterator NewPixelRegionIterator(MagickWand *wand,const long x,
const long y,const unsigned long columns,const unsigned long rows,
const MagickBooleanType modify)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>wand</h5>
<ol><p>the magick wand.</p></ol>
<h5>x,y,columns,rows</h5>
<ol><p>These values define the perimeter of a region of pixels.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
</div>
<p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p></ol>
<p>The format of the PixelGetCurrentIteratorRow method is:</p>
<pre class="code">
PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
unsigned long *number_wands)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the pixel iterator.</p></ol>
<h5>number_wands</h5>
<ol><p>the number of pixel wands.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="PixelGetIteratorException">PixelGetIteratorException</a></h2>
</div>
<p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
<p>The format of the PixelGetIteratorException method is:</p>
<pre class="code">
char *PixelGetIteratorException(const Pixeliterator *iterator,
ExceptionType *severity)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the pixel iterator.</p></ol>
<h5>severity</h5>
<ol><p>the severity of the error is returned here.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a></h2>
</div>
<p>PixelGetIteratorExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
<p>The format of the PixelGetIteratorExceptionType method is:</p>
<pre class="code">
ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>wand</h5>
<ol><p>the magick wand.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="PixelGetIteratorRow">PixelGetIteratorRow</a></h2>
</div>
<p>PixelGetIteratorRow() returns the current pixel iterator row.</p></ol>
<p>The format of the PixelGetIteratorRow method is:</p>
<pre class="code">
MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the pixel iterator.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
</div>
<p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
<p>The format of the PixelGetNextIteratorRow method is:</p>
<pre class="code">
PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
unsigned long *number_wands)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the pixel iterator.</p></ol>
<h5>number_wands</h5>
<ol><p>the number of pixel wands.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
</div>
<p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p></ol>
<p>The format of the PixelGetPreviousIteratorRow method is:</p>
<pre class="code">
PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
unsigned long *number_wands)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the pixel iterator.</p></ol>
<h5>number_wands</h5>
<ol><p>the number of pixel wands.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="PixelResetIterator">PixelResetIterator</a></h2>
</div>
<p>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.</p></ol>
<p>The format of the PixelResetIterator method is:</p>
<pre class="code">
void PixelResetIterator(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the pixel iterator.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
</div>
<p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p></ol>
<p>The format of the PixelSetFirstIteratorRow method is:</p>
<pre class="code">
void PixelSetFirstIteratorRow(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the magick iterator.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
</div>
<p>PixelSetIteratorRow() set the pixel iterator row.</p></ol>
<p>The format of the PixelSetIteratorRow method is:</p>
<pre class="code">
MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
const long row)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the pixel iterator.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
</div>
<p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p></ol>
<p>The format of the PixelSetLastIteratorRow method is:</p>
<pre class="code">
void PixelSetLastIteratorRow(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the magick iterator.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/wand/pixel-iterator.c
?view=markup" target="source" name="PixelSyncIterator">PixelSyncIterator</a></h2>
</div>
<p>PixelSyncIterator() syncs the pixel iterator.</p></ol>
<p>The format of the PixelSyncIterator method is:</p>
<pre class="code">
MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>iterator</h5>
<ol><p>the pixel iterator.</p></ol>
</td>
<td id="margin" width="1%" height="100%" valign="top" align="right"> </td>
</tr>
</tbody>
</table>
<div id="linkbar">
<a href="http://www.imagemagick.org/discourse-server/" target="807149714">Discourse Server</a> •
<a href="../../www/mailing-list.html">Mailing Lists</a> •
<a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi" target="75089378">ImageMagick Studio</a>
</div>
<div id="footer">
<span id="footer-west">© 1999-2008 ImageMagick Studio LLC</span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>
