Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 307ba18d4753632f19e873143d01e0b6ba2dbaad / . / www / api / pixel-iterator.html
blob: 2577576d45e7f54790844673e4b1e700dab37ec3 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickWand, C API for ImageMagick: Pixel Iterator Methods</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <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, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]30</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]48<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]49
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]52</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]53<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]54<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]55 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]93</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]94<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]119 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]122 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127
128<div class="sponsbox">
129<div class="sponsor">
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame^]130 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]131</div>
132<div class="sponsor">
133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy0391e8d2010-04-10 01:36:10 +0000[diff] [blame]143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]149</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]153
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]166</div>
167
168<div class="main">
169
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame^]170<h1>Module pixel-iterator
171 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]172<p class="navigation-index">[<a href="#ClearPixelIterator">ClearPixelIterator</a> &bull; <a href="#ClonePixelIterator">ClonePixelIterator</a> &bull; <a href="#DestroyPixelIterator">DestroyPixelIterator</a> &bull; <a href="#IsPixelIterator">IsPixelIterator</a> &bull; <a href="#NewPixelIterator">NewPixelIterator</a> &bull; <a href="#PixelClearIteratorException">PixelClearIteratorException</a> &bull; <a href="#NewPixelRegionIterator">NewPixelRegionIterator</a> &bull; <a href="#PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a> &bull; <a href="#PixelGetIteratorException">PixelGetIteratorException</a> &bull; <a href="#PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a> &bull; <a href="#PixelGetIteratorRow">PixelGetIteratorRow</a> &bull; <a href="#PixelGetNextIteratorRow">PixelGetNextIteratorRow</a> &bull; <a href="#PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a> &bull; <a href="#PixelResetIterator">PixelResetIterator</a> &bull; <a href="#PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a> &bull; <a href="#PixelSetIteratorRow">PixelSetIteratorRow</a> &bull; <a href="#PixelSetLastIteratorRow">PixelSetLastIteratorRow</a> &bull; <a href="#PixelSyncIterator">PixelSyncIterator</a>]</p>
173
174<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
175_8c.html" target="source" name="ClearPixelIterator">ClearPixelIterator</a></h2>
176<div class="doc-section">
177
178<p>ClearPixelIterator() clear resources associated with a PixelIterator.</p></ol>
179
180<p>The format of the ClearPixelIterator method is:</p>
181
182<pre class="code">
183 PixelIterator *ClearPixelIterator(PixelIterator *iterator)
184</pre>
185
186<p>A description of each parameter follows:</p></ol>
187
188<h5>iterator</h5>
189<ol><p>the pixel iterator.</p></ol>
190
191 </div>
192<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
193_8c.html" target="source" name="ClonePixelIterator">ClonePixelIterator</a></h2>
194<div class="doc-section">
195
196<p>ClonePixelIterator() makes an exact copy of the specified iterator.</p></ol>
197
198<p>The format of the ClonePixelIterator method is:</p>
199
200<pre class="code">
201 PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
202</pre>
203
204<p>A description of each parameter follows:</p></ol>
205
206<h5>iterator</h5>
207<ol><p>the magick iterator.</p></ol>
208
209 </div>
210<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
211_8c.html" target="source" name="DestroyPixelIterator">DestroyPixelIterator</a></h2>
212<div class="doc-section">
213
214<p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p></ol>
215
216<p>The format of the DestroyPixelIterator method is:</p>
217
218<pre class="code">
219 PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
220</pre>
221
222<p>A description of each parameter follows:</p></ol>
223
224<h5>iterator</h5>
225<ol><p>the pixel iterator.</p></ol>
226
227 </div>
228<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
229_8c.html" target="source" name="IsPixelIterator">IsPixelIterator</a></h2>
230<div class="doc-section">
231
232<p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p></ol>
233
234<p>The format of the IsPixelIterator method is:</p>
235
236<pre class="code">
237 MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
238</pre>
239
240<p>A description of each parameter follows:</p></ol>
241
242<h5>iterator</h5>
243<ol><p>the magick iterator.</p></ol>
244
245 </div>
246<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
247_8c.html" target="source" name="NewPixelIterator">NewPixelIterator</a></h2>
248<div class="doc-section">
249
250<p>NewPixelIterator() returns a new pixel iterator.</p></ol>
251
252<p>The format of the NewPixelIterator method is:</p>
253
254<pre class="code">
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]255 PixelIterator *NewPixelIterator(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]256</pre>
257
258<p>A description of each parameter follows:</p></ol>
259
260<h5>wand</h5>
261<ol><p>the magick wand.</p></ol>
262
263 </div>
264<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
265_8c.html" target="source" name="PixelClearIteratorException">PixelClearIteratorException</a></h2>
266<div class="doc-section">
267
268<p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p></ol>
269
270<p>The format of the PixelClearIteratorException method is:</p>
271
272<pre class="code">
273 MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
274</pre>
275
276<p>A description of each parameter follows:</p></ol>
277
278<h5>wand</h5>
279<ol><p>the pixel wand.</p></ol>
280
281 </div>
282<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
283_8c.html" target="source" name="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
284<div class="doc-section">
285
286<p>NewPixelRegionIterator() returns a new pixel iterator.</p></ol>
287
288<p>The format of the NewPixelRegionIterator method is:</p>
289
290<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]291 PixelIterator NewPixelRegionIterator(MagickWand *wand,const ssize_t x,
292 const ssize_t y,const size_t width,const size_t height)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]293</pre>
294
295<p>A description of each parameter follows:</p></ol>
296
297<h5>wand</h5>
298<ol><p>the magick wand.</p></ol>
299
300<h5>x,y,columns,rows</h5>
301<ol><p>These values define the perimeter of a region of pixels.</p></ol>
302
303 </div>
304<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
305_8c.html" target="source" name="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
306<div class="doc-section">
307
308<p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p></ol>
309
310<p>The format of the PixelGetCurrentIteratorRow method is:</p>
311
312<pre class="code">
313 PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]314 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]315</pre>
316
317<p>A description of each parameter follows:</p></ol>
318
319<h5>iterator</h5>
320<ol><p>the pixel iterator.</p></ol>
321
322<h5>number_wands</h5>
323<ol><p>the number of pixel wands.</p></ol>
324
325 </div>
326<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
327_8c.html" target="source" name="PixelGetIteratorException">PixelGetIteratorException</a></h2>
328<div class="doc-section">
329
330<p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
331
332<p>The format of the PixelGetIteratorException method is:</p>
333
334<pre class="code">
335 char *PixelGetIteratorException(const Pixeliterator *iterator,
336 ExceptionType *severity)
337</pre>
338
339<p>A description of each parameter follows:</p></ol>
340
341<h5>iterator</h5>
342<ol><p>the pixel iterator.</p></ol>
343
344<h5>severity</h5>
345<ol><p>the severity of the error is returned here.</p></ol>
346
347 </div>
348<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
349_8c.html" target="source" name="PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a></h2>
350<div class="doc-section">
351
352<p>PixelGetIteratorExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
353
354<p>The format of the PixelGetIteratorExceptionType method is:</p>
355
356<pre class="code">
357 ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
358</pre>
359
360<p>A description of each parameter follows:</p></ol>
361
362<h5>wand</h5>
363<ol><p>the magick wand.</p></ol>
364
365 </div>
366<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
367_8c.html" target="source" name="PixelGetIteratorRow">PixelGetIteratorRow</a></h2>
368<div class="doc-section">
369
370<p>PixelGetIteratorRow() returns the current pixel iterator row.</p></ol>
371
372<p>The format of the PixelGetIteratorRow method is:</p>
373
374<pre class="code">
375 MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
376</pre>
377
378<p>A description of each parameter follows:</p></ol>
379
380<h5>iterator</h5>
381<ol><p>the pixel iterator.</p></ol>
382
383 </div>
384<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
385_8c.html" target="source" name="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
386<div class="doc-section">
387
388<p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
389
390<p>The format of the PixelGetNextIteratorRow method is:</p>
391
392<pre class="code">
393 PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]394 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]395</pre>
396
397<p>A description of each parameter follows:</p></ol>
398
399<h5>iterator</h5>
400<ol><p>the pixel iterator.</p></ol>
401
402<h5>number_wands</h5>
403<ol><p>the number of pixel wands.</p></ol>
404
405 </div>
406<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
407_8c.html" target="source" name="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
408<div class="doc-section">
409
410<p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p></ol>
411
412<p>The format of the PixelGetPreviousIteratorRow method is:</p>
413
414<pre class="code">
415 PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]416 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]417</pre>
418
419<p>A description of each parameter follows:</p></ol>
420
421<h5>iterator</h5>
422<ol><p>the pixel iterator.</p></ol>
423
424<h5>number_wands</h5>
425<ol><p>the number of pixel wands.</p></ol>
426
427 </div>
428<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
429_8c.html" target="source" name="PixelResetIterator">PixelResetIterator</a></h2>
430<div class="doc-section">
431
432<p>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.</p></ol>
433
434<p>The format of the PixelResetIterator method is:</p>
435
436<pre class="code">
437 void PixelResetIterator(PixelIterator *iterator)
438</pre>
439
440<p>A description of each parameter follows:</p></ol>
441
442<h5>iterator</h5>
443<ol><p>the pixel iterator.</p></ol>
444
445 </div>
446<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
447_8c.html" target="source" name="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
448<div class="doc-section">
449
450<p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p></ol>
451
452<p>The format of the PixelSetFirstIteratorRow method is:</p>
453
454<pre class="code">
455 void PixelSetFirstIteratorRow(PixelIterator *iterator)
456</pre>
457
458<p>A description of each parameter follows:</p></ol>
459
460<h5>iterator</h5>
461<ol><p>the magick iterator.</p></ol>
462
463 </div>
464<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
465_8c.html" target="source" name="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
466<div class="doc-section">
467
468<p>PixelSetIteratorRow() set the pixel iterator row.</p></ol>
469
470<p>The format of the PixelSetIteratorRow method is:</p>
471
472<pre class="code">
473 MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]474 const ssize_t row)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]475</pre>
476
477<p>A description of each parameter follows:</p></ol>
478
479<h5>iterator</h5>
480<ol><p>the pixel iterator.</p></ol>
481
482 </div>
483<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
484_8c.html" target="source" name="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
485<div class="doc-section">
486
487<p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p></ol>
488
489<p>The format of the PixelSetLastIteratorRow method is:</p>
490
491<pre class="code">
492 void PixelSetLastIteratorRow(PixelIterator *iterator)
493</pre>
494
495<p>A description of each parameter follows:</p></ol>
496
497<h5>iterator</h5>
498<ol><p>the magick iterator.</p></ol>
499
500 </div>
501<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
502_8c.html" target="source" name="PixelSyncIterator">PixelSyncIterator</a></h2>
503<div class="doc-section">
504
505<p>PixelSyncIterator() syncs the pixel iterator.</p></ol>
506
507<p>The format of the PixelSyncIterator method is:</p>
508
509<pre class="code">
510 MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
511</pre>
512
513<p>A description of each parameter follows:</p></ol>
514
515<h5>iterator</h5>
516<ol><p>the pixel iterator.</p></ol>
517
518 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]519
520</div>
521
522<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]523 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]524 <span id="linkbar-center">
525 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]526 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]527 </span>
528 <span id="linkbar-east">&nbsp;</span>
529 </div>
530 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]531 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]532 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
533 </div>
534 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]535 <script type="text/javascript">
536 var _gaq = _gaq || [];
537 _gaq.push(['_setAccount', 'UA-17690367-1']);
538 _gaq.push(['_trackPageview']);
539
540 (function() {
541 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
542 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
543 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
544 })();
545 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]546</body>
547</html>