Tryag File Manager

//usr/share/doc/ImageMagick-6.2.8/www/api/pixel-iterator.html

<?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">
<head>
  <style type="text/css"></style>
  <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, PerlMagick, Magick++, Image, Magick"/>
  <meta name="Description" content="ImageMagick (TM) is a free software suite to create, edit and compose bitmap images. It can read, convert and write images in a large variety of formats. Images can be cropped, colors can be changed, various effects can be applied, images can be rotated and combined, and text, lines, polygons, ellipses and Bézier curves can be added to images and stretched and rotated.  ImageMagick is free software: it is delivered with full source code and can be freely used, copied, modified and distributed. Its license is compatible with the GPL. It runs on all major operating systems.  Most of the functionality of ImageMagick can be used interactively from the command line; more often, however, the features are used from programs written in the programming languages Perl, C, C++, Python, PHP, Ruby or Java, for which ready-made ImageMagick interfaces (PerlMagick, Magick++, PythonMagick, MagickWand for PHP, RubyMagick, and JMagick) are available. This makes it possible to modify or create images automatically and dynamically.  ImageMagick supports many image formats (over 90 major formats) including popular formats like TIFF, JPEG, PNG, PDF, PhotoCD, and GIF."/>
  <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-2006 ImageMagick Studio LLC"/>
  <meta name="Distribution" content="Global"/>
  <link rel="shortcut icon" href="/../images/wand.ico"  type="image/x-icon"/>
</head>

<tr valign="top" style="height: 100%;">
      <td id="menu" width="1%" height="100%">
      <p><a href="#main">Skip to page contents</a></p>
      <span>[</span>
      <a href="../../index.html">About ImageMagick</a>
      <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="../../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="../../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#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/links.html">Links</a>
  <span>]</span><br /><br /><span>[</span>
      <a href="../../www/sponsors.html">Sponsors</a>
  <a href="http://www.sharedlog.com" class="sponsor" target="sponsor">Your Free Photo<br />Blog</a>
      <span>]</span>
      </td>

<td id="main" valign="top">
<p class="navigation-index">[ <a href="#ClearPixelIterator">ClearPixelIterator</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="#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 name="ClearPixelIterator">ClearPixelIterator</a></h2>
</div>

<p>ClearPixelIterator() clear resources associated with a PixelIterator.</p>

<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>

<h4>iterator</h4>
<p>The pixel iterator.</p>

<div style="margin: auto;">
  <h2><a name="DestroyPixelIterator">DestroyPixelIterator</a></h2>
</div>

<p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p>

<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>

<h4>iterator</h4>
<p>The pixel iterator.</p>

<div style="margin: auto;">
  <h2><a name="IsPixelIterator">IsPixelIterator</a></h2>
</div>

<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="code">
  MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
</pre>

<p>A description of each parameter follows:</p>

<h4>iterator</h4>
<p>The magick iterator.</p>

<div style="margin: auto;">
  <h2><a name="NewPixelIterator">NewPixelIterator</a></h2>
</div>

<p>NewPixelIterator() returns a new pixel iterator.</p>

<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>

<h4>wand</h4>
<p>The magick wand.</p>

<div style="margin: auto;">
  <h2><a name="PixelClearIteratorException">PixelClearIteratorException</a></h2>
</div>

<p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p>

<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>

<h4>wand</h4>
<p>The pixel wand.</p>

<div style="margin: auto;">
  <h2><a name="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
</div>

<p>NewPixelRegionIterator() returns a new pixel iterator.</p>

<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>

<h4>wand</h4>
<p>The magick wand.</p>

<h4>x,y,columns,rows</h4>
<p>These values define the perimeter of a region of pixels.</p>

<div style="margin: auto;">
  <h2><a name="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
</div>

<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="code">
  PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
    unsigned long *number_wands)
</pre>

<p>A description of each parameter follows:</p>

<h4>iterator</h4>
<p>The pixel iterator.</p>

<h4>number_wands</h4>
<p>The number of pixel wands.</p>

<div style="margin: auto;">
  <h2><a 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>

<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>

<h4>iterator</h4>
<p>The pixel iterator.</p>

<h4>severity</h4>
<p>The severity of the error is returned here.</p>

<div style="margin: auto;">
  <h2><a name="PixelGetIteratorRow">PixelGetIteratorRow</a></h2>
</div>

<p>PixelGetIteratorRow() returns the crurent pixel iterator row.</p>

<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>

<h4>iterator</h4>
<p>The pixel iterator.</p>

<div style="margin: auto;">
  <h2><a name="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
</div>

<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="code">
  PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
    unsigned long *number_wands)
</pre>

<p>A description of each parameter follows:</p>

<h4>iterator</h4>
<p>The pixel iterator.</p>

<h4>number_wands</h4>
<p>The number of pixel wands.</p>

<div style="margin: auto;">
  <h2><a name="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
</div>

<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="code">
  PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
    unsigned long *number_wands)
</pre>

<p>A description of each parameter follows:</p>

<h4>iterator</h4>
<p>The pixel iterator.</p>

<h4>number_wands</h4>
<p>The number of pixel wands.</p>

<div style="margin: auto;">
  <h2><a name="PixelResetIterator">PixelResetIterator</a></h2>
</div>

<p>PixelResetIterator() resets the pixel iterator.  Use it in conjunction with PixelGetNextPixel() to iterate over all the pixels in a pixel container.</p>

<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>

<h4>iterator</h4>
<p>The pixel iterator.</p>

<div style="margin: auto;">
  <h2><a name="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
</div>

<p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p>

<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>

<h4>iterator</h4>
<p>The magick iterator.</p>

<div style="margin: auto;">
  <h2><a name="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
</div>

<p>PixelSetIteratorRow() set the pixel iterator row.</p>

<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>

<h4>iterator</h4>
<p>The pixel iterator.</p>

<div style="margin: auto;">
  <h2><a name="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
</div>

<p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p>

<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>

<h4>iterator</h4>
<p>The magick iterator.</p>

<div style="margin: auto;">
  <h2><a name="PixelSyncIterator">PixelSyncIterator</a></h2>
</div>

<p>PixelSyncIterator() syncs the pixel iterator.</p>

<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>

<h4>iterator</h4>
<p>The pixel iterator.</p>

</td>
      <td id="margin" width="1%" height="100%" valign="top" align="right">&nbsp;</td>
    </tr>
  </tbody>
  </table>
  <div id="linkbar">
    <a href="http://redux.imagemagick.org/discussion-server" target="358994055">Discourse Server</a> |
    <a href="../../www/mailing-list.html">Mailing Lists</a> |
    <a href="http://redux.imagemagick.org/gallery" target="1901783905">Image Gallery</a> |
    <a href="http://studio.webbyland.com/MagickStudio/scripts/MagickStudio.cgi" target="1485512459">ImageMagick Studio</a>
  </div>
  <div>
    <span id="footer-west">&copy; 1999-2006 ImageMagick Studio LLC</span>
  </div>
  <div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>