1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>pixel_iterator - Pixel Iterator</title>
<link rel="stylesheet" type="text/css" href="../magick.css">
</head>
<body marginheight="1" marginwidth="1" topmargin="1" leftmargin="1">
<a name="top"></a>
<table border="0" cellpadding="0" cellspacing="0" summary="Masthead" width="100%">
<tbody>
<tr>
<td bgcolor="#003399" width="25%" height="118" background="../../images/background.gif"><a href="http://www.imagemagick.org/"><img src="../../images/script.gif" width="278" height="118" border="0" alt="" /></a></td>
<td bgcolor="#003399" width="60%" height="118" background="../../images/background.gif"><a href="http://www.networkeleven.com/direct.php?magick_all"><img src="../../images/promote.png" border="0" width="186" height="52" vspace="29" alt="Powered by NetworkEleven" /></a></td>
<td bgcolor="#003399" width="114" height="118" align="right"><img src="../../images/sprite.png" width="114" height="118" alt="" /></td>
<td bgcolor="#003399" width="114" height="118" align="right"><a href="http://www.imagemagick.net"><img src="../../images/logo.png" width="114" height="118" border="0" alt="ImageMagick logo" /></a></td>
</tr></tbody></table>
<table align="left" border="0" cellpadding="2" cellspacing="2" summary="Navigation buttons" width="20%">
<tr>
<td>
<form target="_self" action="../../index.html"><input type="submit" title="ImageMagick Home" value=" Home" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td>
<td>
<form target="_self" action="../../www/apis.html"><input type="submit" title="ImageMagick API" value=" API " style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td>
<td>
<form target="_self" action="../../www/archives.html"><input type="submit" title="ImageMagick Download" value="Download" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td></tr></table>
<div align="right" style="margin-top:3px; padding-right:4px">
<form action="http://studio.imagemagick.org/Sage/scripts/Sage.cgi"><input type="TEXT" name="query" size="32" maxlength="255"> <input type="SUBMIT" name="sa" value="Search" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); bgcolor:#003399; color:#fbc713; font-weight:bold"></form></div>
<table align="left" border="0" cellpadding="10" cellspacing="0" style="margin-top:-17px" width="100%">
<tr>
<td>
<P><a name="__index__"></a></P>
<!-- INDEX BEGIN -->
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#function_descriptions">FUNCTION DESCRIPTIONS</a></li>
<ul>
<li><a href="#destroypixeliterator">DestroyPixelIterator</a></li>
<li><a href="#newpixeliterator">NewPixelIterator</a></li>
<li><a href="#newpixelregioniterator">NewPixelRegionIterator</a></li>
<li><a href="#pixeliteratorgetexception">PixelIteratorGetException</a></li>
<li><a href="#pixelgetnextrow">PixelGetNextRow</a></li>
<li><a href="#pixelresetiterator">PixelResetIterator</a></li>
<li><a href="#pixelsetiteratorrow">PixelSetIteratorRow</a></li>
<li><a href="#pixelsynciterator">PixelSyncIterator</a></li>
</ul>
</ul>
<!-- INDEX END -->
<hr />
<P>
</P>
<h1><a name="name">NAME</a></h1>
<P>pixel_iterator - Pixel Iterator</P>
<P>
</P>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<P>MagickBooleanType <strong>DestroyPixelIterator</strong>( PixelIterator *iterator );</P>
<P>PixelIterator <strong>NewPixelIterator</strong>( MagickWand *wand );</P>
<P>PixelIterator <strong>NewPixelRegionIterator</strong>( MagickWand *wand, const long x, const long y, const unsigned long columns, const unsigned long rows, const MagickBooleanType modify );</P>
<P>PixelWand * <strong>PixelGetNextRow</strong>( PixelIterator *iterator );</P>
<P>char * <strong>PixelIteratorGetException</strong>( const Pixeliterator *iterator, ExceptionType *severity );</P>
<P>void <strong>PixelResetIterator</strong>( PixelIterator *iterator );</P>
<P>MagickBooleanType <strong>PixelSetIteratorRow</strong>( PixelIterator *iterator, const long row );</P>
<P>MagickBooleanType <strong>PixelSyncIterator</strong>( PixelIterator *iterator );</P>
<P>
</P>
<hr />
<h1><a name="function_descriptions">FUNCTION DESCRIPTIONS</a></h1>
<P>
</P>
<h2><a name="destroypixeliterator">DestroyPixelIterator</a></h2>
<blockquote>DestroyPixelIterator() deallocates resources associated with a PixelIterator. </blockquote><P>The format of the DestroyPixelIterator method is:</P>
<blockquote>MagickBooleanType DestroyPixelIterator ( PixelIterator *iterator ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_iterator_3a">iterator:</a></strong><br />
</dt>
<DD>
The pixel iterator.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="newpixeliterator">NewPixelIterator</a></h2>
<blockquote>NewPixelIterator() returns a new pixel iterator. </blockquote><P>The format of the NewPixelIterator method is:</P>
<blockquote>PixelIterator NewPixelIterator ( MagickWand *wand ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_wand_3a">wand:</a></strong><br />
</dt>
<DD>
The magick wand.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="newpixelregioniterator">NewPixelRegionIterator</a></h2>
<blockquote>NewPixelRegionIterator() returns a new pixel iterator. </blockquote><P>The format of the NewPixelRegionIterator method is:</P>
<blockquote>PixelIterator NewPixelRegionIterator ( MagickWand *wand, const long x, const long y, const unsigned long columns, const unsigned long rows, const MagickBooleanType modify ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>wand:</strong><br />
</dt>
<DD>
The magick wand.
</dd>
<P></P>
<dt><strong><a name="item_o_x_2cy_2ccolumns_2crows_3a">x,y,columns,rows:</a></strong><br />
</dt>
<DD>
These values define the perimeter of a region of pixels.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="pixeliteratorgetexception">PixelIteratorGetException</a></h2>
<blockquote>PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API. </blockquote><P>The format of the PixelIteratorGetException method is:</P>
<blockquote>char *PixelIteratorGetException ( const Pixeliterator *iterator, <A HREF="types.html#ExceptionType">ExceptionType</A> *severity ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>iterator:</strong><br />
</dt>
<DD>
The pixel iterator.
</dd>
<P></P>
<dt><strong><a name="item_o_severity_3a">severity:</a></strong><br />
</dt>
<DD>
The severity of the error is returned here.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="pixelgetnextrow">PixelGetNextRow</a></h2>
<blockquote>PixelGetNextRow() returns the next row from the pixel iterator. </blockquote><P>The format of the PixelGetNextRow method is:</P>
<blockquote>PixelWand *PixelGetNextRow ( PixelIterator *iterator ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>iterator:</strong><br />
</dt>
<DD>
The pixel iterator.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="pixelresetiterator">PixelResetIterator</a></h2>
<blockquote>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextPixel ( ) to iterate over all the pixels in a pixel container. </blockquote><P>The format of the PixelResetIterator method is:</P>
<blockquote>void PixelResetIterator ( PixelIterator *iterator ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>iterator:</strong><br />
</dt>
<DD>
The pixel iterator.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="pixelsetiteratorrow">PixelSetIteratorRow</a></h2>
<blockquote>PixelSetIteratorRow() set the pixel iterator row. </blockquote><P>The format of the PixelSetIteratorRow method is:</P>
<blockquote>MagickBooleanType PixelSetIteratorRow ( PixelIterator *iterator, const long row ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>iterator:</strong><br />
</dt>
<DD>
The pixel iterator.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="pixelsynciterator">PixelSyncIterator</a></h2>
<blockquote>PixelSyncIterator() syncs the pixel iterator. </blockquote><P>The format of the PixelSyncIterator method is:</P>
<blockquote>MagickBooleanType PixelSyncIterator ( PixelIterator *iterator ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>iterator:</strong><br />
</dt>
<DD>
The pixel iterator.
</dd>
</dl>
<HR>
<a href="#top"><img src="../../../images/top.gif" border=0 width=42 height=42 align="right" alt="Top of page"></a>
<form action="http://studio.imagemagick.org/magick/" style="margin-top:5px">
<input type="submit" title="Help!" value="Help!" style="background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold">
<small>"Image manipulation software that works like magick"</small>
</form></td>
</tr></table>
</body>
</html>
|