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 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
\r
8 <style type="text/css" media="all">
\r
9 @import url("../../www/magick.css");
\r
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"/>
25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
26 <meta name="Distribution" content="Global"/>
29 <body id="www-imagemagick-org">
\r
30 <div class="titlebar">
\r
31 <a href="../../index.html">
\r
32 <img src="../../images/script.png" alt="[ImageMagick]"
\r
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
34 <a href="http://www.networkredux.com">
\r
35 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
37 <a href="http://www.imagemagick.org/discourse-server/">
\r
38 <img src="../../images/logo.jpg" alt=""
\r
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
40 <a href="../../index.html">
\r
41 <img src="../../images/sprite.jpg" alt=""
\r
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
45 <div class="eastbar">
\r
48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
50 <div class="sep"></div>
\r
52 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
63 <div class="sep"></div>
\r
65 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
68 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
71 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
77 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
80 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
83 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
86 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
89 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
91 <div class="sep"></div>
\r
93 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
96 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
99 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
102 <a title="Resources" href="../../www/resources.html">Resources</a>
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
108 <a title="Download" href="../../www/download.html">Download</a>
110 <div class="sep"></div>
\r
112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
114 <div class="sep"></div>
\r
116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
121 <div class="sep"></div>
\r
123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
125 <div class="sponsbox">
126 <div class="sponsor">
127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
129 <div class="sponsor">
130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
132 <div class="sponsor">
133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
135 <div class="sponsor">
136 <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
138 <div class="sponsor">
139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
141 <div class="sponsor">
142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
144 <div class="sponsor">
145 <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/" title="Online-Magazin">Online-Magazin</a><!-- 20101101000200 -->
155 <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>
157 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
158 _8c.html" target="source" name="ClearPixelIterator">ClearPixelIterator</a></h2>
159 <div class="doc-section">
161 <p>ClearPixelIterator() clear resources associated with a PixelIterator.</p></ol>
163 <p>The format of the ClearPixelIterator method is:</p>
166 PixelIterator *ClearPixelIterator(PixelIterator *iterator)
169 <p>A description of each parameter follows:</p></ol>
172 <ol><p>the pixel iterator.</p></ol>
175 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
176 _8c.html" target="source" name="ClonePixelIterator">ClonePixelIterator</a></h2>
177 <div class="doc-section">
179 <p>ClonePixelIterator() makes an exact copy of the specified iterator.</p></ol>
181 <p>The format of the ClonePixelIterator method is:</p>
184 PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
187 <p>A description of each parameter follows:</p></ol>
190 <ol><p>the magick iterator.</p></ol>
193 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
194 _8c.html" target="source" name="DestroyPixelIterator">DestroyPixelIterator</a></h2>
195 <div class="doc-section">
197 <p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p></ol>
199 <p>The format of the DestroyPixelIterator method is:</p>
202 PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
205 <p>A description of each parameter follows:</p></ol>
208 <ol><p>the pixel iterator.</p></ol>
211 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
212 _8c.html" target="source" name="IsPixelIterator">IsPixelIterator</a></h2>
213 <div class="doc-section">
215 <p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p></ol>
217 <p>The format of the IsPixelIterator method is:</p>
220 MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
223 <p>A description of each parameter follows:</p></ol>
226 <ol><p>the magick iterator.</p></ol>
229 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
230 _8c.html" target="source" name="NewPixelIterator">NewPixelIterator</a></h2>
231 <div class="doc-section">
233 <p>NewPixelIterator() returns a new pixel iterator.</p></ol>
235 <p>The format of the NewPixelIterator method is:</p>
238 PixelIterator NewPixelIterator(MagickWand *wand)
241 <p>A description of each parameter follows:</p></ol>
244 <ol><p>the magick wand.</p></ol>
247 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
248 _8c.html" target="source" name="PixelClearIteratorException">PixelClearIteratorException</a></h2>
249 <div class="doc-section">
251 <p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p></ol>
253 <p>The format of the PixelClearIteratorException method is:</p>
256 MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
259 <p>A description of each parameter follows:</p></ol>
262 <ol><p>the pixel wand.</p></ol>
265 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
266 _8c.html" target="source" name="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
267 <div class="doc-section">
269 <p>NewPixelRegionIterator() returns a new pixel iterator.</p></ol>
271 <p>The format of the NewPixelRegionIterator method is:</p>
274 PixelIterator NewPixelRegionIterator(MagickWand *wand,const ssize_t x,
275 const ssize_t y,const size_t width,const size_t height)
278 <p>A description of each parameter follows:</p></ol>
281 <ol><p>the magick wand.</p></ol>
283 <h5>x,y,columns,rows</h5>
284 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
287 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
288 _8c.html" target="source" name="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
289 <div class="doc-section">
291 <p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p></ol>
293 <p>The format of the PixelGetCurrentIteratorRow method is:</p>
296 PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
297 size_t *number_wands)
300 <p>A description of each parameter follows:</p></ol>
303 <ol><p>the pixel iterator.</p></ol>
305 <h5>number_wands</h5>
306 <ol><p>the number of pixel wands.</p></ol>
309 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
310 _8c.html" target="source" name="PixelGetIteratorException">PixelGetIteratorException</a></h2>
311 <div class="doc-section">
313 <p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
315 <p>The format of the PixelGetIteratorException method is:</p>
318 char *PixelGetIteratorException(const Pixeliterator *iterator,
319 ExceptionType *severity)
322 <p>A description of each parameter follows:</p></ol>
325 <ol><p>the pixel iterator.</p></ol>
328 <ol><p>the severity of the error is returned here.</p></ol>
331 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
332 _8c.html" target="source" name="PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a></h2>
333 <div class="doc-section">
335 <p>PixelGetIteratorExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
337 <p>The format of the PixelGetIteratorExceptionType method is:</p>
340 ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
343 <p>A description of each parameter follows:</p></ol>
346 <ol><p>the magick wand.</p></ol>
349 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
350 _8c.html" target="source" name="PixelGetIteratorRow">PixelGetIteratorRow</a></h2>
351 <div class="doc-section">
353 <p>PixelGetIteratorRow() returns the current pixel iterator row.</p></ol>
355 <p>The format of the PixelGetIteratorRow method is:</p>
358 MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
361 <p>A description of each parameter follows:</p></ol>
364 <ol><p>the pixel iterator.</p></ol>
367 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
368 _8c.html" target="source" name="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
369 <div class="doc-section">
371 <p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
373 <p>The format of the PixelGetNextIteratorRow method is:</p>
376 PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
377 size_t *number_wands)
380 <p>A description of each parameter follows:</p></ol>
383 <ol><p>the pixel iterator.</p></ol>
385 <h5>number_wands</h5>
386 <ol><p>the number of pixel wands.</p></ol>
389 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
390 _8c.html" target="source" name="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
391 <div class="doc-section">
393 <p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p></ol>
395 <p>The format of the PixelGetPreviousIteratorRow method is:</p>
398 PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
399 size_t *number_wands)
402 <p>A description of each parameter follows:</p></ol>
405 <ol><p>the pixel iterator.</p></ol>
407 <h5>number_wands</h5>
408 <ol><p>the number of pixel wands.</p></ol>
411 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
412 _8c.html" target="source" name="PixelResetIterator">PixelResetIterator</a></h2>
413 <div class="doc-section">
415 <p>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.</p></ol>
417 <p>The format of the PixelResetIterator method is:</p>
420 void PixelResetIterator(PixelIterator *iterator)
423 <p>A description of each parameter follows:</p></ol>
426 <ol><p>the pixel iterator.</p></ol>
429 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
430 _8c.html" target="source" name="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
431 <div class="doc-section">
433 <p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p></ol>
435 <p>The format of the PixelSetFirstIteratorRow method is:</p>
438 void PixelSetFirstIteratorRow(PixelIterator *iterator)
441 <p>A description of each parameter follows:</p></ol>
444 <ol><p>the magick iterator.</p></ol>
447 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
448 _8c.html" target="source" name="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
449 <div class="doc-section">
451 <p>PixelSetIteratorRow() set the pixel iterator row.</p></ol>
453 <p>The format of the PixelSetIteratorRow method is:</p>
456 MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
460 <p>A description of each parameter follows:</p></ol>
463 <ol><p>the pixel iterator.</p></ol>
466 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
467 _8c.html" target="source" name="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
468 <div class="doc-section">
470 <p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p></ol>
472 <p>The format of the PixelSetLastIteratorRow method is:</p>
475 void PixelSetLastIteratorRow(PixelIterator *iterator)
478 <p>A description of each parameter follows:</p></ol>
481 <ol><p>the magick iterator.</p></ol>
484 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
485 _8c.html" target="source" name="PixelSyncIterator">PixelSyncIterator</a></h2>
486 <div class="doc-section">
488 <p>PixelSyncIterator() syncs the pixel iterator.</p></ol>
490 <p>The format of the PixelSyncIterator method is:</p>
493 MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
496 <p>A description of each parameter follows:</p></ol>
499 <ol><p>the pixel iterator.</p></ol>
506 <!-- <span id="linkbar-west"> </span> -->
\r
507 <span id="linkbar-center">
\r
508 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
509 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
511 <span id="linkbar-east"> </span>
\r
513 <div class="footer">
\r
514 <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
\r
515 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
517 <div style="clear: both; margin: 0; width: 100%; "></div>
\r