1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
\r
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml: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, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
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-2011 ImageMagick Studio LLC"/>
23 <meta name="Distribution" content="Global"/>
24 <link rel="icon" href="../../images/wand.png"/>
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
30 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
\r
31 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
\r
32 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
\r
33 <script type="text/javascript">
\r
34 $(document).ready(function() {
\r
35 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
\r
36 'transitionIn' : 'elastic',
\r
37 'transitionOut' : 'elastic',
\r
38 'overlayShow' : false,
\r
45 <body id="www-imagemagick-org">
\r
46 <div class="titlebar">
\r
47 <a href="../../index.html">
\r
48 <img src="../../images/script.png" alt="[ImageMagick]"
\r
49 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
50 <a href="http://www.networkredux.com">
\r
51 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
52 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
53 <a href="http://www.imagemagick.org/discourse-server/">
\r
54 <img src="../../images/logo.jpg" alt=""
\r
55 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
56 <a href="../../index.html">
\r
57 <img src="../../images/sprite.jpg" alt=""
\r
58 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
61 <div class="westbar">
\r
64 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
66 <div class="sep"></div>
\r
68 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
71 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
74 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
77 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79 <div class="sep"></div>
\r
81 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
84 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
87 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
90 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
93 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
96 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
99 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
102 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
105 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
107 <div class="sep"></div>
\r
109 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
112 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
115 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
118 <a title="Resources" href="../../www/resources.html">Resources</a>
121 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
124 <a title="Download" href="../../www/download.html">Download</a>
126 <div class="sep"></div>
\r
128 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
130 <div class="sep"></div>
\r
132 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
135 <a title="Site Map: Links" href="../../www/links.html">Links</a>
137 <div class="sep"></div>
\r
139 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
141 <div class="sponsbox">
142 <div class="sponsor">
143 <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011040100025 gabi.schulze-->
145 <div class="sponsor">
146 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
148 <div class="sponsor">
149 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151 <div class="sponsor">
152 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
158 <div class="eastbar">
\r
159 <script type="text/javascript">
\r
161 google_ad_client = "pub-3129977114552745";
\r
162 google_ad_slot = "0574824969";
\r
163 google_ad_width = 160;
\r
164 google_ad_height = 600;
\r
167 <script type="text/javascript"
\r
168 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
\r
174 <h1>Module pixel-iterator
176 <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>
178 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
179 _8c.html" target="source" name="ClearPixelIterator">ClearPixelIterator</a></h2>
180 <div class="doc-section">
182 <p>ClearPixelIterator() clear resources associated with a PixelIterator.</p></ol>
184 <p>The format of the ClearPixelIterator method is:</p>
187 PixelIterator *ClearPixelIterator(PixelIterator *iterator)
190 <p>A description of each parameter follows:</p></ol>
193 <ol><p>the pixel iterator.</p></ol>
196 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
197 _8c.html" target="source" name="ClonePixelIterator">ClonePixelIterator</a></h2>
198 <div class="doc-section">
200 <p>ClonePixelIterator() makes an exact copy of the specified iterator.</p></ol>
202 <p>The format of the ClonePixelIterator method is:</p>
205 PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
208 <p>A description of each parameter follows:</p></ol>
211 <ol><p>the magick iterator.</p></ol>
214 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
215 _8c.html" target="source" name="DestroyPixelIterator">DestroyPixelIterator</a></h2>
216 <div class="doc-section">
218 <p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p></ol>
220 <p>The format of the DestroyPixelIterator method is:</p>
223 PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
226 <p>A description of each parameter follows:</p></ol>
229 <ol><p>the pixel iterator.</p></ol>
232 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
233 _8c.html" target="source" name="IsPixelIterator">IsPixelIterator</a></h2>
234 <div class="doc-section">
236 <p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p></ol>
238 <p>The format of the IsPixelIterator method is:</p>
241 MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
244 <p>A description of each parameter follows:</p></ol>
247 <ol><p>the magick iterator.</p></ol>
250 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
251 _8c.html" target="source" name="NewPixelIterator">NewPixelIterator</a></h2>
252 <div class="doc-section">
254 <p>NewPixelIterator() returns a new pixel iterator.</p></ol>
256 <p>The format of the NewPixelIterator method is:</p>
259 PixelIterator *NewPixelIterator(MagickWand *wand)
262 <p>A description of each parameter follows:</p></ol>
265 <ol><p>the magick wand.</p></ol>
268 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
269 _8c.html" target="source" name="PixelClearIteratorException">PixelClearIteratorException</a></h2>
270 <div class="doc-section">
272 <p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p></ol>
274 <p>The format of the PixelClearIteratorException method is:</p>
277 MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
280 <p>A description of each parameter follows:</p></ol>
283 <ol><p>the pixel wand.</p></ol>
286 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
287 _8c.html" target="source" name="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
288 <div class="doc-section">
290 <p>NewPixelRegionIterator() returns a new pixel iterator.</p></ol>
292 <p>The format of the NewPixelRegionIterator method is:</p>
295 PixelIterator NewPixelRegionIterator(MagickWand *wand,const ssize_t x,
296 const ssize_t y,const size_t width,const size_t height)
299 <p>A description of each parameter follows:</p></ol>
302 <ol><p>the magick wand.</p></ol>
304 <h5>x,y,columns,rows</h5>
305 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
308 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
309 _8c.html" target="source" name="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
310 <div class="doc-section">
312 <p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p></ol>
314 <p>The format of the PixelGetCurrentIteratorRow method is:</p>
317 PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
318 size_t *number_wands)
321 <p>A description of each parameter follows:</p></ol>
324 <ol><p>the pixel iterator.</p></ol>
326 <h5>number_wands</h5>
327 <ol><p>the number of pixel wands.</p></ol>
330 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
331 _8c.html" target="source" name="PixelGetIteratorException">PixelGetIteratorException</a></h2>
332 <div class="doc-section">
334 <p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
336 <p>The format of the PixelGetIteratorException method is:</p>
339 char *PixelGetIteratorException(const Pixeliterator *iterator,
340 ExceptionType *severity)
343 <p>A description of each parameter follows:</p></ol>
346 <ol><p>the pixel iterator.</p></ol>
349 <ol><p>the severity of the error is returned here.</p></ol>
352 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
353 _8c.html" target="source" name="PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a></h2>
354 <div class="doc-section">
356 <p>PixelGetIteratorExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
358 <p>The format of the PixelGetIteratorExceptionType method is:</p>
361 ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
364 <p>A description of each parameter follows:</p></ol>
367 <ol><p>the magick wand.</p></ol>
370 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
371 _8c.html" target="source" name="PixelGetIteratorRow">PixelGetIteratorRow</a></h2>
372 <div class="doc-section">
374 <p>PixelGetIteratorRow() returns the current pixel iterator row.</p></ol>
376 <p>The format of the PixelGetIteratorRow method is:</p>
379 MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
382 <p>A description of each parameter follows:</p></ol>
385 <ol><p>the pixel iterator.</p></ol>
388 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
389 _8c.html" target="source" name="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
390 <div class="doc-section">
392 <p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
394 <p>The format of the PixelGetNextIteratorRow method is:</p>
397 PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
398 size_t *number_wands)
401 <p>A description of each parameter follows:</p></ol>
404 <ol><p>the pixel iterator.</p></ol>
406 <h5>number_wands</h5>
407 <ol><p>the number of pixel wands.</p></ol>
410 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
411 _8c.html" target="source" name="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
412 <div class="doc-section">
414 <p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p></ol>
416 <p>The format of the PixelGetPreviousIteratorRow method is:</p>
419 PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
420 size_t *number_wands)
423 <p>A description of each parameter follows:</p></ol>
426 <ol><p>the pixel iterator.</p></ol>
428 <h5>number_wands</h5>
429 <ol><p>the number of pixel wands.</p></ol>
432 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
433 _8c.html" target="source" name="PixelResetIterator">PixelResetIterator</a></h2>
434 <div class="doc-section">
436 <p>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.</p></ol>
438 <p>The format of the PixelResetIterator method is:</p>
441 void PixelResetIterator(PixelIterator *iterator)
444 <p>A description of each parameter follows:</p></ol>
447 <ol><p>the pixel iterator.</p></ol>
450 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
451 _8c.html" target="source" name="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
452 <div class="doc-section">
454 <p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p></ol>
456 <p>The format of the PixelSetFirstIteratorRow method is:</p>
459 void PixelSetFirstIteratorRow(PixelIterator *iterator)
462 <p>A description of each parameter follows:</p></ol>
465 <ol><p>the magick iterator.</p></ol>
468 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
469 _8c.html" target="source" name="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
470 <div class="doc-section">
472 <p>PixelSetIteratorRow() set the pixel iterator row.</p></ol>
474 <p>The format of the PixelSetIteratorRow method is:</p>
477 MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
481 <p>A description of each parameter follows:</p></ol>
484 <ol><p>the pixel iterator.</p></ol>
487 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
488 _8c.html" target="source" name="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
489 <div class="doc-section">
491 <p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p></ol>
493 <p>The format of the PixelSetLastIteratorRow method is:</p>
496 void PixelSetLastIteratorRow(PixelIterator *iterator)
499 <p>A description of each parameter follows:</p></ol>
502 <ol><p>the magick iterator.</p></ol>
505 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
506 _8c.html" target="source" name="PixelSyncIterator">PixelSyncIterator</a></h2>
507 <div class="doc-section">
509 <p>PixelSyncIterator() syncs the pixel iterator.</p></ol>
511 <p>The format of the PixelSyncIterator method is:</p>
514 MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
517 <p>A description of each parameter follows:</p></ol>
520 <ol><p>the pixel iterator.</p></ol>
527 <span id="linkbar-west"> </span>
\r
528 <span id="linkbar-center">
\r
529 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
530 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
532 <span id="linkbar-east"> </span>
\r
534 <div class="footer">
\r
535 <span id="footer-west">© 1999-2011 ImageMagick Studio LLC</span>
\r
536 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
538 <div style="clear: both; margin: 0; width: 100%; "></div>
\r
539 <script type="text/javascript">
\r
540 var _gaq = _gaq || [];
\r
541 _gaq.push(['_setAccount', 'UA-17690367-1']);
\r
542 _gaq.push(['_trackPageview']);
\r
545 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
\r
546 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
\r
547 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
\r