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