blob: 916d67f74dd54bb4e9ec094ad68133241eb69618 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<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="[email protected]">
<meta name="application-name" content="ImageMagick">
<meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
<meta name="application-url" content="http://www.imagemagick.org">
<meta name="generator" content="PHP">
<meta name="keywords" content="magickwc, api, for, imagemagick:, pixel, iterator, methods, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
<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">
<meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
<link rel="icon" href="../../images/wand.png">
<link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon">
<link rel="stylesheet" href="../../css/bootstrap.min.css">
<link rel="stylesheet" href="../../css/magick.css">
</head>
<body>
<div class="main">
<div class="magick-masthead">
<div class="container">
<script type="text/javascript">
<!--
google_ad_client = "pub-3129977114552745";
google_ad_slot = "5439289906";
google_ad_width = 728;
google_ad_height = 90;
//-->
</script>
<center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script></center>
<nav class="magick-nav">
<a class="magick-nav-item " href="../../index.html">Home</a>
<a class="magick-nav-item " href="../../www/binary-releases.html">Downloads</a>
<a class="magick-nav-item " href="../../www/command-line-tools.html">Tools</a>
<a class="magick-nav-item " href="../../www/command-line-options.html">Options</a>
<a class="magick-nav-item " href="../../www/api.html">Development</a>
<a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a>
<a class="magick-nav-item navbar-right " href="http://www.imagemagick.org/script/search.php">Search</a>
</nav>
</div>
</div>
<div class="container">
<p class="text-center"><a href="pixel-iterator.html#ClearPixelIterator">ClearPixelIterator</a><a href="pixel-iterator.html#ClonePixelIterator">ClonePixelIterator</a><a href="pixel-iterator.html#DestroyPixelIterator">DestroyPixelIterator</a><a href="pixel-iterator.html#IsPixelIterator">IsPixelIterator</a><a href="pixel-iterator.html#NewPixelIterator">NewPixelIterator</a><a href="pixel-iterator.html#PixelClearIteratorException">PixelClearIteratorException</a><a href="pixel-iterator.html#NewPixelRegionIterator">NewPixelRegionIterator</a><a href="pixel-iterator.html#PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a><a href="pixel-iterator.html#PixelGetIteratorException">PixelGetIteratorException</a><a href="pixel-iterator.html#PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a><a href="pixel-iterator.html#PixelGetIteratorRow">PixelGetIteratorRow</a><a href="pixel-iterator.html#PixelGetNextIteratorRow">PixelGetNextIteratorRow</a><a href="pixel-iterator.html#PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a><a href="pixel-iterator.html#PixelResetIterator">PixelResetIterator</a><a href="pixel-iterator.html#PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a><a href="pixel-iterator.html#PixelSetIteratorRow">PixelSetIteratorRow</a><a href="pixel-iterator.html#PixelSetLastIteratorRow">PixelSetLastIteratorRow</a><a href="pixel-iterator.html#PixelSyncIterator">PixelSyncIterator</a></p>
<div class="magick-header">
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="ClearPixelIterator">ClearPixelIterator</a></h2>
<p>ClearPixelIterator() clear resources associated with a PixelIterator.</p>
<p>The format of the ClearPixelIterator method is:</p>
<pre class="text">
void ClearPixelIterator(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the pixel iterator. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="ClonePixelIterator">ClonePixelIterator</a></h2>
<p>ClonePixelIterator() makes an exact copy of the specified iterator.</p>
<p>The format of the ClonePixelIterator method is:</p>
<pre class="text">
PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the magick iterator. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="DestroyPixelIterator">DestroyPixelIterator</a></h2>
<p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p>
<p>The format of the DestroyPixelIterator method is:</p>
<pre class="text">
PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the pixel iterator. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="IsPixelIterator">IsPixelIterator</a></h2>
<p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p>
<p>The format of the IsPixelIterator method is:</p>
<pre class="text">
MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the magick iterator. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="NewPixelIterator">NewPixelIterator</a></h2>
<p>NewPixelIterator() returns a new pixel iterator.</p>
<p>The format of the NewPixelIterator method is:</p>
<pre class="text">
PixelIterator *NewPixelIterator(MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>wand</dt>
<dd>the magick wand. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelClearIteratorException">PixelClearIteratorException</a></h2>
<p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p>
<p>The format of the PixelClearIteratorException method is:</p>
<pre class="text">
MagickBooleanType PixelClearIteratorException(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the pixel iterator. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
<p>NewPixelRegionIterator() returns a new pixel iterator.</p>
<p>The format of the NewPixelRegionIterator method is:</p>
<pre class="text">
PixelIterator *NewPixelRegionIterator(MagickWand *wand,const ssize_t x,
const ssize_t y,const size_t width,const size_t height)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>wand</dt>
<dd>the magick wand. </dd>
<dd> </dd>
<dt>x,y,columns,rows</dt>
<dd> These values define the perimeter of a region of pixels. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
<p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p>
<p>The format of the PixelGetCurrentIteratorRow method is:</p>
<pre class="text">
PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
size_t *number_wands)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the pixel iterator. </dd>
<dd> </dd>
<dt>number_wands</dt>
<dd>the number of pixel wands. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelGetIteratorException">PixelGetIteratorException</a></h2>
<p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
<p>The format of the PixelGetIteratorException method is:</p>
<pre class="text">
char *PixelGetIteratorException(const PixelIterator *iterator,
ExceptionType *severity)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the pixel iterator. </dd>
<dd> </dd>
<dt>severity</dt>
<dd>the severity of the error is returned here. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a></h2>
<p>PixelGetIteratorExceptionType() the exception type associated with the iterator. If no exception has occurred, UndefinedExceptionType is returned.</p>
<p>The format of the PixelGetIteratorExceptionType method is:</p>
<pre class="text">
ExceptionType PixelGetIteratorExceptionType(
const PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the pixel iterator. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelGetIteratorRow">PixelGetIteratorRow</a></h2>
<p>PixelGetIteratorRow() returns the current pixel iterator row.</p>
<p>The format of the PixelGetIteratorRow method is:</p>
<pre class="text">
MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the pixel iterator. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
<p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p>
<p>The format of the PixelGetNextIteratorRow method is:</p>
<pre class="text">
PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
size_t *number_wands)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the pixel iterator. </dd>
<dd> </dd>
<dt>number_wands</dt>
<dd>the number of pixel wands. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
<p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p>
<p>The format of the PixelGetPreviousIteratorRow method is:</p>
<pre class="text">
PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
size_t *number_wands)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the pixel iterator. </dd>
<dd> </dd>
<dt>number_wands</dt>
<dd>the number of pixel wands. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelResetIterator">PixelResetIterator</a></h2>
<p>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.</p>
<p>The format of the PixelResetIterator method is:</p>
<pre class="text">
void PixelResetIterator(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the pixel iterator. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
<p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p>
<p>The format of the PixelSetFirstIteratorRow method is:</p>
<pre class="text">
void PixelSetFirstIteratorRow(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the magick iterator. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
<p>PixelSetIteratorRow() set the pixel iterator row.</p>
<p>The format of the PixelSetIteratorRow method is:</p>
<pre class="text">
MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
const ssize_t row)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the pixel iterator. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
<p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p>
<p>The format of the PixelSetLastIteratorRow method is:</p>
<pre class="text">
void PixelSetLastIteratorRow(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the magick iterator. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelSyncIterator">PixelSyncIterator</a></h2>
<p>PixelSyncIterator() syncs the pixel iterator.</p>
<p>The format of the PixelSyncIterator method is:</p>
<pre class="text">
MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>iterator</dt>
<dd>the pixel iterator. </dd>
<dd> </dd>
</dl>
</div>
<footer class="magick-footer">
<div class="magick-nav-item navbar-left">
<a href="../../www/support.html">Donate</a>
</div>
<div class="magick-nav-item navbar-right">
<a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a>
<noscript>
<a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
<img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>
</noscript>
</div>
<p><a href="../../www/sitemap.html">Sitemap</a>
<a href="../../www/links.html">Related</a>
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a>
<a href="http://jqmagick.imagemagick.org/">JqMagick</a>
<a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
</p>
<p><a href="pixel-iterator.html#">Back to top</a>
<a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
</footer>
</div><!-- /.container -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script type="text/javascript">
/* */
(function() {
var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
s.type = 'text/javascript';
s.async = true;
s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
t.parentNode.insertBefore(s, t);
})();
/* */
</script>
</div>
</body>
</html>