Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 4103d56aa7c2e34492b59b2b5677ce7700097cca / . / www / api / pixel-iterator.html
blob: f9b50967e8bea562defbaf764e2a43e92afcc9df [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="/>
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"/>
12 <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."/>
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">
cristy83a272e2010-05-07 20:40:35 +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">
cristy83a272e2010-05-07 20:40:35 +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">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame^]130 <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011040100025 gabi.schulze-->
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
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]170<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>
171
172<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
173_8c.html" target="source" name="ClearPixelIterator">ClearPixelIterator</a></h2>
174<div class="doc-section">
175
176<p>ClearPixelIterator() clear resources associated with a PixelIterator.</p></ol>
177
178<p>The format of the ClearPixelIterator method is:</p>
179
180<pre class="code">
181 PixelIterator *ClearPixelIterator(PixelIterator *iterator)
182</pre>
183
184<p>A description of each parameter follows:</p></ol>
185
186<h5>iterator</h5>
187<ol><p>the pixel iterator.</p></ol>
188
189 </div>
190<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
191_8c.html" target="source" name="ClonePixelIterator">ClonePixelIterator</a></h2>
192<div class="doc-section">
193
194<p>ClonePixelIterator() makes an exact copy of the specified iterator.</p></ol>
195
196<p>The format of the ClonePixelIterator method is:</p>
197
198<pre class="code">
199 PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
200</pre>
201
202<p>A description of each parameter follows:</p></ol>
203
204<h5>iterator</h5>
205<ol><p>the magick iterator.</p></ol>
206
207 </div>
208<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
209_8c.html" target="source" name="DestroyPixelIterator">DestroyPixelIterator</a></h2>
210<div class="doc-section">
211
212<p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p></ol>
213
214<p>The format of the DestroyPixelIterator method is:</p>
215
216<pre class="code">
217 PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
218</pre>
219
220<p>A description of each parameter follows:</p></ol>
221
222<h5>iterator</h5>
223<ol><p>the pixel iterator.</p></ol>
224
225 </div>
226<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
227_8c.html" target="source" name="IsPixelIterator">IsPixelIterator</a></h2>
228<div class="doc-section">
229
230<p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p></ol>
231
232<p>The format of the IsPixelIterator method is:</p>
233
234<pre class="code">
235 MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
236</pre>
237
238<p>A description of each parameter follows:</p></ol>
239
240<h5>iterator</h5>
241<ol><p>the magick iterator.</p></ol>
242
243 </div>
244<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
245_8c.html" target="source" name="NewPixelIterator">NewPixelIterator</a></h2>
246<div class="doc-section">
247
248<p>NewPixelIterator() returns a new pixel iterator.</p></ol>
249
250<p>The format of the NewPixelIterator method is:</p>
251
252<pre class="code">
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]253 PixelIterator *NewPixelIterator(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]254</pre>
255
256<p>A description of each parameter follows:</p></ol>
257
258<h5>wand</h5>
259<ol><p>the magick wand.</p></ol>
260
261 </div>
262<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
263_8c.html" target="source" name="PixelClearIteratorException">PixelClearIteratorException</a></h2>
264<div class="doc-section">
265
266<p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p></ol>
267
268<p>The format of the PixelClearIteratorException method is:</p>
269
270<pre class="code">
271 MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
272</pre>
273
274<p>A description of each parameter follows:</p></ol>
275
276<h5>wand</h5>
277<ol><p>the pixel wand.</p></ol>
278
279 </div>
280<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
281_8c.html" target="source" name="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
282<div class="doc-section">
283
284<p>NewPixelRegionIterator() returns a new pixel iterator.</p></ol>
285
286<p>The format of the NewPixelRegionIterator method is:</p>
287
288<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]289 PixelIterator NewPixelRegionIterator(MagickWand *wand,const ssize_t x,
290 const ssize_t y,const size_t width,const size_t height)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]291</pre>
292
293<p>A description of each parameter follows:</p></ol>
294
295<h5>wand</h5>
296<ol><p>the magick wand.</p></ol>
297
298<h5>x,y,columns,rows</h5>
299<ol><p>These values define the perimeter of a region of pixels.</p></ol>
300
301 </div>
302<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
303_8c.html" target="source" name="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
304<div class="doc-section">
305
306<p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p></ol>
307
308<p>The format of the PixelGetCurrentIteratorRow method is:</p>
309
310<pre class="code">
311 PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]312 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]313</pre>
314
315<p>A description of each parameter follows:</p></ol>
316
317<h5>iterator</h5>
318<ol><p>the pixel iterator.</p></ol>
319
320<h5>number_wands</h5>
321<ol><p>the number of pixel wands.</p></ol>
322
323 </div>
324<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
325_8c.html" target="source" name="PixelGetIteratorException">PixelGetIteratorException</a></h2>
326<div class="doc-section">
327
328<p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
329
330<p>The format of the PixelGetIteratorException method is:</p>
331
332<pre class="code">
333 char *PixelGetIteratorException(const Pixeliterator *iterator,
334 ExceptionType *severity)
335</pre>
336
337<p>A description of each parameter follows:</p></ol>
338
339<h5>iterator</h5>
340<ol><p>the pixel iterator.</p></ol>
341
342<h5>severity</h5>
343<ol><p>the severity of the error is returned here.</p></ol>
344
345 </div>
346<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
347_8c.html" target="source" name="PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a></h2>
348<div class="doc-section">
349
350<p>PixelGetIteratorExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
351
352<p>The format of the PixelGetIteratorExceptionType method is:</p>
353
354<pre class="code">
355 ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
356</pre>
357
358<p>A description of each parameter follows:</p></ol>
359
360<h5>wand</h5>
361<ol><p>the magick wand.</p></ol>
362
363 </div>
364<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
365_8c.html" target="source" name="PixelGetIteratorRow">PixelGetIteratorRow</a></h2>
366<div class="doc-section">
367
368<p>PixelGetIteratorRow() returns the current pixel iterator row.</p></ol>
369
370<p>The format of the PixelGetIteratorRow method is:</p>
371
372<pre class="code">
373 MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
374</pre>
375
376<p>A description of each parameter follows:</p></ol>
377
378<h5>iterator</h5>
379<ol><p>the pixel iterator.</p></ol>
380
381 </div>
382<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
383_8c.html" target="source" name="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
384<div class="doc-section">
385
386<p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
387
388<p>The format of the PixelGetNextIteratorRow method is:</p>
389
390<pre class="code">
391 PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]392 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]393</pre>
394
395<p>A description of each parameter follows:</p></ol>
396
397<h5>iterator</h5>
398<ol><p>the pixel iterator.</p></ol>
399
400<h5>number_wands</h5>
401<ol><p>the number of pixel wands.</p></ol>
402
403 </div>
404<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
405_8c.html" target="source" name="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
406<div class="doc-section">
407
408<p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p></ol>
409
410<p>The format of the PixelGetPreviousIteratorRow method is:</p>
411
412<pre class="code">
413 PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]414 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]415</pre>
416
417<p>A description of each parameter follows:</p></ol>
418
419<h5>iterator</h5>
420<ol><p>the pixel iterator.</p></ol>
421
422<h5>number_wands</h5>
423<ol><p>the number of pixel wands.</p></ol>
424
425 </div>
426<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
427_8c.html" target="source" name="PixelResetIterator">PixelResetIterator</a></h2>
428<div class="doc-section">
429
430<p>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.</p></ol>
431
432<p>The format of the PixelResetIterator method is:</p>
433
434<pre class="code">
435 void PixelResetIterator(PixelIterator *iterator)
436</pre>
437
438<p>A description of each parameter follows:</p></ol>
439
440<h5>iterator</h5>
441<ol><p>the pixel iterator.</p></ol>
442
443 </div>
444<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
445_8c.html" target="source" name="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
446<div class="doc-section">
447
448<p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p></ol>
449
450<p>The format of the PixelSetFirstIteratorRow method is:</p>
451
452<pre class="code">
453 void PixelSetFirstIteratorRow(PixelIterator *iterator)
454</pre>
455
456<p>A description of each parameter follows:</p></ol>
457
458<h5>iterator</h5>
459<ol><p>the magick iterator.</p></ol>
460
461 </div>
462<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
463_8c.html" target="source" name="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
464<div class="doc-section">
465
466<p>PixelSetIteratorRow() set the pixel iterator row.</p></ol>
467
468<p>The format of the PixelSetIteratorRow method is:</p>
469
470<pre class="code">
471 MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]472 const ssize_t row)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]473</pre>
474
475<p>A description of each parameter follows:</p></ol>
476
477<h5>iterator</h5>
478<ol><p>the pixel iterator.</p></ol>
479
480 </div>
481<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
482_8c.html" target="source" name="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
483<div class="doc-section">
484
485<p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p></ol>
486
487<p>The format of the PixelSetLastIteratorRow method is:</p>
488
489<pre class="code">
490 void PixelSetLastIteratorRow(PixelIterator *iterator)
491</pre>
492
493<p>A description of each parameter follows:</p></ol>
494
495<h5>iterator</h5>
496<ol><p>the magick iterator.</p></ol>
497
498 </div>
499<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
500_8c.html" target="source" name="PixelSyncIterator">PixelSyncIterator</a></h2>
501<div class="doc-section">
502
503<p>PixelSyncIterator() syncs the pixel iterator.</p></ol>
504
505<p>The format of the PixelSyncIterator method is:</p>
506
507<pre class="code">
508 MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
509</pre>
510
511<p>A description of each parameter follows:</p></ol>
512
513<h5>iterator</h5>
514<ol><p>the pixel iterator.</p></ol>
515
516 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]517
518</div>
519
520<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]521 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]522 <span id="linkbar-center">
523 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]524 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]525 </span>
526 <span id="linkbar-east">&nbsp;</span>
527 </div>
528 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame^]529 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]530 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
531 </div>
532 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]533 <script type="text/javascript">
534 var _gaq = _gaq || [];
535 _gaq.push(['_setAccount', 'UA-17690367-1']);
536 _gaq.push(['_trackPageview']);
537
538 (function() {
539 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
540 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
541 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
542 })();
543 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]544</body>
545</html>