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