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">
\r
5 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
\r
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
\r
7 <style type="text/css" media="screen,projection"><!--
\r
8 @import url("../../www/magick.css");
\r
10 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
11 <title>ImageMagick: MagickWand, C API for ImageMagick: Pixel Iterator Methods</title>
12 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
15 <meta name="Generator" content="PHP"/>
16 <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"/>
17 <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."/>
18 <meta name="Rating" content="GENERAL"/>
19 <meta name="Robots" content="INDEX, FOLLOW"/>
20 <meta name="Generator" content="ImageMagick Studio LLC"/>
21 <meta name="Author" content="ImageMagick Studio LLC"/>
22 <meta name="Revisit-after" content="2 DAYS"/>
23 <meta name="Resource-type" content="document"/>
24 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
25 <meta name="Distribution" content="Global"/>
28 <body id="www-imagemagick-org">
\r
29 <div class="titlebar">
\r
30 <a href="../../index.html">
\r
31 <img src="../../images/script.png" alt="[ImageMagick]"
\r
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
33 <a href="http://www.networkredux.com">
\r
34 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
36 <a href="http://www.imagemagick.org/discourse-server/">
\r
37 <img src="../../images/logo.jpg" alt=""
\r
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
39 <a href="../../index.html">
\r
40 <img src="../../images/sprite.jpg" alt=""
\r
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
44 <div class="eastbar">
\r
47 <a href="../../index.html">About ImageMagick</a>
49 <div class="sep"></div>
\r
51 <a href="../../www/command-line-tools.html">Command-line Tools</a>
54 <a href="../../www/command-line-processing.html">Processing</a>
57 <a href="../../www/command-line-options.html">Options</a>
60 <a href="http://www.imagemagick.org/Usage/">Usage</a>
63 <a href="../../www/api.html">Program Interfaces</a>
66 <a href="../../www/magick-wand.html">MagickWand</a>
69 <a href="../../www/magick-core.html">MagickCore</a>
72 <a href="../../www/perl-magick.html">PerlMagick</a>
75 <a href="../../Magick++/">Magick++</a>
78 <a href="../../www/architecture.html">Architecture</a>
80 <div class="sep"></div>
\r
82 <a href="../../www/install-source.html">Install from Source</a>
85 <a href="../../www/install-source.html#unix">Unix</a>
88 <a href="../../www/install-source.html#windows">Windows</a>
91 <a href="../../www/binary-releases.html">Binary Releases</a>
94 <a href="../../www/binary-releases.html#unix">Unix</a>
97 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
100 <a href="../../www/binary-releases.html#windows">Windows</a>
103 <a href="../../www/resources.html">Resources</a>
105 <div class="sep"></div>
\r
107 <a href="../../www/download.html">Download</a>
109 <div class="sep"></div>
\r
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113 <div class="sep"></div>
\r
115 <a href="../../www/sitemap.html">Site Map</a>
118 <a href="../../www/links.html">Links</a>
120 <div class="sep"></div>
\r
122 <a href="../../www/sponsors.html">Sponsors:</a>
124 <div class="sponsbox">
125 <div class="sponsor">
126 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
128 <div class="sponsor">
129 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
131 <div class="sponsor">
132 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
134 <div class="sponsor">
135 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
137 <div class="sponsor">
138 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
140 <div class="sponsor">
141 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
151 <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>
153 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
154 _8c.html" target="source" name="ClearPixelIterator">ClearPixelIterator</a></h2>
155 <div class="doc-section">
157 <p>ClearPixelIterator() clear resources associated with a PixelIterator.</p></ol>
159 <p>The format of the ClearPixelIterator method is:</p>
162 PixelIterator *ClearPixelIterator(PixelIterator *iterator)
165 <p>A description of each parameter follows:</p></ol>
168 <ol><p>the pixel iterator.</p></ol>
171 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
172 _8c.html" target="source" name="ClonePixelIterator">ClonePixelIterator</a></h2>
173 <div class="doc-section">
175 <p>ClonePixelIterator() makes an exact copy of the specified iterator.</p></ol>
177 <p>The format of the ClonePixelIterator method is:</p>
180 PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
183 <p>A description of each parameter follows:</p></ol>
186 <ol><p>the magick iterator.</p></ol>
189 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
190 _8c.html" target="source" name="DestroyPixelIterator">DestroyPixelIterator</a></h2>
191 <div class="doc-section">
193 <p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p></ol>
195 <p>The format of the DestroyPixelIterator method is:</p>
198 PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
201 <p>A description of each parameter follows:</p></ol>
204 <ol><p>the pixel iterator.</p></ol>
207 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
208 _8c.html" target="source" name="IsPixelIterator">IsPixelIterator</a></h2>
209 <div class="doc-section">
211 <p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p></ol>
213 <p>The format of the IsPixelIterator method is:</p>
216 MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
219 <p>A description of each parameter follows:</p></ol>
222 <ol><p>the magick iterator.</p></ol>
225 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
226 _8c.html" target="source" name="NewPixelIterator">NewPixelIterator</a></h2>
227 <div class="doc-section">
229 <p>NewPixelIterator() returns a new pixel iterator.</p></ol>
231 <p>The format of the NewPixelIterator method is:</p>
234 PixelIterator NewPixelIterator(MagickWand *wand)
237 <p>A description of each parameter follows:</p></ol>
240 <ol><p>the magick wand.</p></ol>
243 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
244 _8c.html" target="source" name="PixelClearIteratorException">PixelClearIteratorException</a></h2>
245 <div class="doc-section">
247 <p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p></ol>
249 <p>The format of the PixelClearIteratorException method is:</p>
252 MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
255 <p>A description of each parameter follows:</p></ol>
258 <ol><p>the pixel wand.</p></ol>
261 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
262 _8c.html" target="source" name="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
263 <div class="doc-section">
265 <p>NewPixelRegionIterator() returns a new pixel iterator.</p></ol>
267 <p>The format of the NewPixelRegionIterator method is:</p>
270 PixelIterator NewPixelRegionIterator(MagickWand *wand,const long x,
271 const long y,const unsigned long width,const unsigned long height)
274 <p>A description of each parameter follows:</p></ol>
277 <ol><p>the magick wand.</p></ol>
279 <h5>x,y,columns,rows</h5>
280 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
283 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
284 _8c.html" target="source" name="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
285 <div class="doc-section">
287 <p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p></ol>
289 <p>The format of the PixelGetCurrentIteratorRow method is:</p>
292 PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
293 unsigned long *number_wands)
296 <p>A description of each parameter follows:</p></ol>
299 <ol><p>the pixel iterator.</p></ol>
301 <h5>number_wands</h5>
302 <ol><p>the number of pixel wands.</p></ol>
305 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
306 _8c.html" target="source" name="PixelGetIteratorException">PixelGetIteratorException</a></h2>
307 <div class="doc-section">
309 <p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
311 <p>The format of the PixelGetIteratorException method is:</p>
314 char *PixelGetIteratorException(const Pixeliterator *iterator,
315 ExceptionType *severity)
318 <p>A description of each parameter follows:</p></ol>
321 <ol><p>the pixel iterator.</p></ol>
324 <ol><p>the severity of the error is returned here.</p></ol>
327 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
328 _8c.html" target="source" name="PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a></h2>
329 <div class="doc-section">
331 <p>PixelGetIteratorExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
333 <p>The format of the PixelGetIteratorExceptionType method is:</p>
336 ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
339 <p>A description of each parameter follows:</p></ol>
342 <ol><p>the magick wand.</p></ol>
345 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
346 _8c.html" target="source" name="PixelGetIteratorRow">PixelGetIteratorRow</a></h2>
347 <div class="doc-section">
349 <p>PixelGetIteratorRow() returns the current pixel iterator row.</p></ol>
351 <p>The format of the PixelGetIteratorRow method is:</p>
354 MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
357 <p>A description of each parameter follows:</p></ol>
360 <ol><p>the pixel iterator.</p></ol>
363 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
364 _8c.html" target="source" name="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
365 <div class="doc-section">
367 <p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
369 <p>The format of the PixelGetNextIteratorRow method is:</p>
372 PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
373 unsigned long *number_wands)
376 <p>A description of each parameter follows:</p></ol>
379 <ol><p>the pixel iterator.</p></ol>
381 <h5>number_wands</h5>
382 <ol><p>the number of pixel wands.</p></ol>
385 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
386 _8c.html" target="source" name="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
387 <div class="doc-section">
389 <p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p></ol>
391 <p>The format of the PixelGetPreviousIteratorRow method is:</p>
394 PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
395 unsigned long *number_wands)
398 <p>A description of each parameter follows:</p></ol>
401 <ol><p>the pixel iterator.</p></ol>
403 <h5>number_wands</h5>
404 <ol><p>the number of pixel wands.</p></ol>
407 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
408 _8c.html" target="source" name="PixelResetIterator">PixelResetIterator</a></h2>
409 <div class="doc-section">
411 <p>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.</p></ol>
413 <p>The format of the PixelResetIterator method is:</p>
416 void PixelResetIterator(PixelIterator *iterator)
419 <p>A description of each parameter follows:</p></ol>
422 <ol><p>the pixel iterator.</p></ol>
425 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
426 _8c.html" target="source" name="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
427 <div class="doc-section">
429 <p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p></ol>
431 <p>The format of the PixelSetFirstIteratorRow method is:</p>
434 void PixelSetFirstIteratorRow(PixelIterator *iterator)
437 <p>A description of each parameter follows:</p></ol>
440 <ol><p>the magick iterator.</p></ol>
443 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
444 _8c.html" target="source" name="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
445 <div class="doc-section">
447 <p>PixelSetIteratorRow() set the pixel iterator row.</p></ol>
449 <p>The format of the PixelSetIteratorRow method is:</p>
452 MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
456 <p>A description of each parameter follows:</p></ol>
459 <ol><p>the pixel iterator.</p></ol>
462 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
463 _8c.html" target="source" name="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
464 <div class="doc-section">
466 <p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p></ol>
468 <p>The format of the PixelSetLastIteratorRow method is:</p>
471 void PixelSetLastIteratorRow(PixelIterator *iterator)
474 <p>A description of each parameter follows:</p></ol>
477 <ol><p>the magick iterator.</p></ol>
480 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
481 _8c.html" target="source" name="PixelSyncIterator">PixelSyncIterator</a></h2>
482 <div class="doc-section">
484 <p>PixelSyncIterator() syncs the pixel iterator.</p></ol>
486 <p>The format of the PixelSyncIterator method is:</p>
489 MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
492 <p>A description of each parameter follows:</p></ol>
495 <ol><p>the pixel iterator.</p></ol>
502 <!-- <span id="linkbar-west"> </span> -->
\r
503 <span id="linkbar-center">
\r
504 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
505 <a href="../../www/mailing-list.html">Mailing Lists</a> •
\r
506 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
508 <span id="linkbar-east"> </span>
\r
510 <div class="footer">
\r
511 <span id="footer-west">© 1999-2009 ImageMagick Studio LLC</span>
\r
512 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
514 <div style="clear: both; margin: 0; width: 100%; "></div>
\r