1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
\r
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
\r
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
\r
7 <title>ImageMagick: MagickWand, C API for ImageMagick: Pixel Iterator Methods</title/>
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"/>
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"/>
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"/>
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"/>
22 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
23 <meta name="Distribution" content="Global"/>
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"/>
\r
27 <style type="text/css" media="all">
\r
28 @import url("../../www/magick.css");
\r
32 <body id="www-imagemagick-org">
\r
33 <div class="titlebar">
\r
34 <a href="../../index.html">
\r
35 <img src="../../images/script.png" alt="[ImageMagick]"
\r
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
37 <a href="http://www.networkredux.com">
\r
38 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
40 <a href="http://www.imagemagick.org/discourse-server/">
\r
41 <img src="../../images/logo.jpg" alt=""
\r
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
43 <a href="../../index.html">
\r
44 <img src="../../images/sprite.jpg" alt=""
\r
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
48 <div class="westbar">
\r
51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
53 <div class="sep"></div>
\r
55 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
66 <div class="sep"></div>
\r
68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
71 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
74 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
83 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
86 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
89 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
94 <div class="sep"></div>
\r
96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
99 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
105 <a title="Resources" href="../../www/resources.html">Resources</a>
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
111 <a title="Download" href="../../www/download.html">Download</a>
113 <div class="sep"></div>
\r
115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
117 <div class="sep"></div>
\r
119 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
122 <a title="Site Map: Links"href="../../www/links.html">Links</a>
124 <div class="sep"></div>
\r
126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
128 <div class="sponsbox">
129 <div class="sponsor">
130 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
132 <div class="sponsor">
133 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
135 <div class="sponsor">
136 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
138 <div class="sponsor">
139 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
141 <div class="sponsor">
142 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
144 <div class="sponsor">
145 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
147 <div class="sponsor">
148 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
154 <div class="eastbar">
\r
155 <script type="text/javascript">
\r
157 google_ad_client = "pub-3129977114552745";
\r
158 google_ad_slot = "0574824969";
\r
159 google_ad_width = 160;
\r
160 google_ad_height = 600;
\r
163 <script type="text/javascript"
\r
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
\r
170 <p class="navigation-index">[<a href="#ClearPixelIterator">ClearPixelIterator</a> • <a href="#ClonePixelIterator">ClonePixelIterator</a> • <a href="#DestroyPixelIterator">DestroyPixelIterator</a> • <a href="#IsPixelIterator">IsPixelIterator</a> • <a href="#NewPixelIterator">NewPixelIterator</a> • <a href="#PixelClearIteratorException">PixelClearIteratorException</a> • <a href="#NewPixelRegionIterator">NewPixelRegionIterator</a> • <a href="#PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a> • <a href="#PixelGetIteratorException">PixelGetIteratorException</a> • <a href="#PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a> • <a href="#PixelGetIteratorRow">PixelGetIteratorRow</a> • <a href="#PixelGetNextIteratorRow">PixelGetNextIteratorRow</a> • <a href="#PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a> • <a href="#PixelResetIterator">PixelResetIterator</a> • <a href="#PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a> • <a href="#PixelSetIteratorRow">PixelSetIteratorRow</a> • <a href="#PixelSetLastIteratorRow">PixelSetLastIteratorRow</a> • <a href="#PixelSyncIterator">PixelSyncIterator</a>]</p>
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">
176 <p>ClearPixelIterator() clear resources associated with a PixelIterator.</p></ol>
178 <p>The format of the ClearPixelIterator method is:</p>
181 PixelIterator *ClearPixelIterator(PixelIterator *iterator)
184 <p>A description of each parameter follows:</p></ol>
187 <ol><p>the pixel iterator.</p></ol>
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">
194 <p>ClonePixelIterator() makes an exact copy of the specified iterator.</p></ol>
196 <p>The format of the ClonePixelIterator method is:</p>
199 PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
202 <p>A description of each parameter follows:</p></ol>
205 <ol><p>the magick iterator.</p></ol>
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">
212 <p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p></ol>
214 <p>The format of the DestroyPixelIterator method is:</p>
217 PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
220 <p>A description of each parameter follows:</p></ol>
223 <ol><p>the pixel iterator.</p></ol>
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">
230 <p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p></ol>
232 <p>The format of the IsPixelIterator method is:</p>
235 MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
238 <p>A description of each parameter follows:</p></ol>
241 <ol><p>the magick iterator.</p></ol>
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">
248 <p>NewPixelIterator() returns a new pixel iterator.</p></ol>
250 <p>The format of the NewPixelIterator method is:</p>
253 PixelIterator *NewPixelIterator(MagickWand *wand)
256 <p>A description of each parameter follows:</p></ol>
259 <ol><p>the magick wand.</p></ol>
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">
266 <p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p></ol>
268 <p>The format of the PixelClearIteratorException method is:</p>
271 MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
274 <p>A description of each parameter follows:</p></ol>
277 <ol><p>the pixel wand.</p></ol>
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">
284 <p>NewPixelRegionIterator() returns a new pixel iterator.</p></ol>
286 <p>The format of the NewPixelRegionIterator method is:</p>
289 PixelIterator NewPixelRegionIterator(MagickWand *wand,const ssize_t x,
290 const ssize_t y,const size_t width,const size_t height)
293 <p>A description of each parameter follows:</p></ol>
296 <ol><p>the magick wand.</p></ol>
298 <h5>x,y,columns,rows</h5>
299 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
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">
306 <p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p></ol>
308 <p>The format of the PixelGetCurrentIteratorRow method is:</p>
311 PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
312 size_t *number_wands)
315 <p>A description of each parameter follows:</p></ol>
318 <ol><p>the pixel iterator.</p></ol>
320 <h5>number_wands</h5>
321 <ol><p>the number of pixel wands.</p></ol>
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">
328 <p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
330 <p>The format of the PixelGetIteratorException method is:</p>
333 char *PixelGetIteratorException(const Pixeliterator *iterator,
334 ExceptionType *severity)
337 <p>A description of each parameter follows:</p></ol>
340 <ol><p>the pixel iterator.</p></ol>
343 <ol><p>the severity of the error is returned here.</p></ol>
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">
350 <p>PixelGetIteratorExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
352 <p>The format of the PixelGetIteratorExceptionType method is:</p>
355 ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
358 <p>A description of each parameter follows:</p></ol>
361 <ol><p>the magick wand.</p></ol>
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">
368 <p>PixelGetIteratorRow() returns the current pixel iterator row.</p></ol>
370 <p>The format of the PixelGetIteratorRow method is:</p>
373 MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
376 <p>A description of each parameter follows:</p></ol>
379 <ol><p>the pixel iterator.</p></ol>
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">
386 <p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
388 <p>The format of the PixelGetNextIteratorRow method is:</p>
391 PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
392 size_t *number_wands)
395 <p>A description of each parameter follows:</p></ol>
398 <ol><p>the pixel iterator.</p></ol>
400 <h5>number_wands</h5>
401 <ol><p>the number of pixel wands.</p></ol>
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">
408 <p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p></ol>
410 <p>The format of the PixelGetPreviousIteratorRow method is:</p>
413 PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
414 size_t *number_wands)
417 <p>A description of each parameter follows:</p></ol>
420 <ol><p>the pixel iterator.</p></ol>
422 <h5>number_wands</h5>
423 <ol><p>the number of pixel wands.</p></ol>
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">
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>
432 <p>The format of the PixelResetIterator method is:</p>
435 void PixelResetIterator(PixelIterator *iterator)
438 <p>A description of each parameter follows:</p></ol>
441 <ol><p>the pixel iterator.</p></ol>
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">
448 <p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p></ol>
450 <p>The format of the PixelSetFirstIteratorRow method is:</p>
453 void PixelSetFirstIteratorRow(PixelIterator *iterator)
456 <p>A description of each parameter follows:</p></ol>
459 <ol><p>the magick iterator.</p></ol>
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">
466 <p>PixelSetIteratorRow() set the pixel iterator row.</p></ol>
468 <p>The format of the PixelSetIteratorRow method is:</p>
471 MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
475 <p>A description of each parameter follows:</p></ol>
478 <ol><p>the pixel iterator.</p></ol>
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">
485 <p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p></ol>
487 <p>The format of the PixelSetLastIteratorRow method is:</p>
490 void PixelSetLastIteratorRow(PixelIterator *iterator)
493 <p>A description of each parameter follows:</p></ol>
496 <ol><p>the magick iterator.</p></ol>
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">
503 <p>PixelSyncIterator() syncs the pixel iterator.</p></ol>
505 <p>The format of the PixelSyncIterator method is:</p>
508 MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
511 <p>A description of each parameter follows:</p></ol>
514 <ol><p>the pixel iterator.</p></ol>
521 <span id="linkbar-west"> </span>
\r
522 <span id="linkbar-center">
\r
523 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
524 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
526 <span id="linkbar-east"> </span>
\r
528 <div class="footer">
\r
529 <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
\r
530 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
532 <div style="clear: both; margin: 0; width: 100%; "></div>
\r
533 <script type="text/javascript">
\r
534 var _gaq = _gaq || [];
\r
535 _gaq.push(['_setAccount', 'UA-17690367-1']);
\r
536 _gaq.push(['_trackPageview']);
\r
539 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
\r
540 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
\r
541 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
\r