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