1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
\r
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
\r
3 <html version="-//W3C//DTD XHTML 1.1//EN"
\r
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
\r
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
\r
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
\r
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
\r
9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
\r
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
\r
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="Application-name" content="ImageMagick"/>
16 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images."/>
17 <meta name="Application-url" content="http://www.imagemagick.org"/>
18 <meta name="Generator" content="PHP"/>
19 <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"/>
20 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
26 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
27 <meta name="Distribution" content="Global"/>
28 <link rel="icon" href="../../images/wand.png"/>
29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
\r
31 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
\r
32 <style type="text/css" media="all">
\r
33 @import url("../../www/magick.css");
\r
35 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
\r
36 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
\r
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
\r
38 <script type="text/javascript">
\r
39 $(document).ready(function() {
\r
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
\r
41 'transitionIn' : 'elastic',
\r
42 'transitionOut' : 'elastic',
\r
43 'overlayShow' : false,
\r
50 <body id="www-imagemagick-org">
\r
51 <div class="titlebar">
\r
52 <a href="../../index.html">
\r
53 <img src="../../images/script.png" alt="[ImageMagick]"
\r
54 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
55 <a href="http://www.networkredux.com">
\r
56 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
57 style="margin-top: 42px; border: 0px; float: left;" /></a>
\r
58 <a href="http://www.imagemagick.org/discourse-server/">
\r
59 <img src="../../images/logo.jpg"
\r
60 alt="ImageMagick Logo"
\r
61 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
\r
62 <a href="../../index.html">
\r
63 <img src="../../images/sprite.jpg"
\r
64 alt="ImageMagick Sprite"
\r
65 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
68 <div class="westbar">
\r
71 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
73 <div class="sep"></div>
\r
75 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
78 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
81 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
84 <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
87 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
89 <div class="sep"></div>
\r
91 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
94 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
97 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
100 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
103 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
106 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
109 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
112 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
115 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
117 <div class="sep"></div>
\r
119 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
122 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
125 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
128 <a title="Resources" href="../../www/resources.html">Resources</a>
131 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
134 <a title="Download" href="../../www/download.html">Download</a>
136 <div class="sep"></div>
\r
138 <a title="Search" href="../../www/search.html">Search</a>
140 <div class="sep"></div>
\r
142 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
145 <a title="Site Map: Links" href="../../www/links.html">Links</a>
147 <div class="sep"></div>
\r
149 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
151 <div class="sponsbox">
152 <div class="sponsor">
153 <a title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
155 <div class="sponsor">
156 <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201106010090 alexanian media -->
158 <div class="sponsor">
159 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
161 <div class="sponsor">
162 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
164 <div class="sponsor">
165 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
167 <div class="sponsor">
168 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
170 <div class="sponsor">
171 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
173 <div class="sponsor">
174 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
176 <div class="sponsor">
177 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
183 <div class="eastbar">
\r
184 <script type="text/javascript">
\r
186 google_ad_client = "pub-3129977114552745";
\r
187 google_ad_slot = "0574824969";
\r
188 google_ad_width = 160;
\r
189 google_ad_height = 600;
\r
192 <script type="text/javascript"
\r
193 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
\r
199 <h1>Module pixel-iterator Methods</h1>
200 <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>
202 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="ClearPixelIterator">ClearPixelIterator</a></h2>
203 <div class="doc-section">
205 <p>ClearPixelIterator() clear resources associated with a PixelIterator.</p>
207 <p>The format of the ClearPixelIterator method is:</p>
210 PixelIterator *ClearPixelIterator(PixelIterator *iterator)
213 <p>A description of each parameter follows:</p>
216 <p>the pixel iterator.</p>
219 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="ClonePixelIterator">ClonePixelIterator</a></h2>
220 <div class="doc-section">
222 <p>ClonePixelIterator() makes an exact copy of the specified iterator.</p>
224 <p>The format of the ClonePixelIterator method is:</p>
227 PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
230 <p>A description of each parameter follows:</p>
233 <p>the magick iterator.</p>
236 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="DestroyPixelIterator">DestroyPixelIterator</a></h2>
237 <div class="doc-section">
239 <p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p>
241 <p>The format of the DestroyPixelIterator method is:</p>
244 PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
247 <p>A description of each parameter follows:</p>
250 <p>the pixel iterator.</p>
253 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="IsPixelIterator">IsPixelIterator</a></h2>
254 <div class="doc-section">
256 <p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p>
258 <p>The format of the IsPixelIterator method is:</p>
261 MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
264 <p>A description of each parameter follows:</p>
267 <p>the magick iterator.</p>
270 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="NewPixelIterator">NewPixelIterator</a></h2>
271 <div class="doc-section">
273 <p>NewPixelIterator() returns a new pixel iterator.</p>
275 <p>The format of the NewPixelIterator method is:</p>
278 PixelIterator *NewPixelIterator(MagickWand *wand)
281 <p>A description of each parameter follows:</p>
284 <p>the magick wand.</p>
287 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelClearIteratorException">PixelClearIteratorException</a></h2>
288 <div class="doc-section">
290 <p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p>
292 <p>The format of the PixelClearIteratorException method is:</p>
295 MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
298 <p>A description of each parameter follows:</p>
301 <p>the pixel wand.</p>
304 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
305 <div class="doc-section">
307 <p>NewPixelRegionIterator() returns a new pixel iterator.</p>
309 <p>The format of the NewPixelRegionIterator method is:</p>
312 PixelIterator NewPixelRegionIterator(MagickWand *wand,const ssize_t x,
313 const ssize_t y,const size_t width,const size_t height)
316 <p>A description of each parameter follows:</p>
319 <p>the magick wand.</p>
321 <h5>x,y,columns,rows</h5>
322 <p>These values define the perimeter of a region of pixels.</p>
325 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
326 <div class="doc-section">
328 <p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p>
330 <p>The format of the PixelGetCurrentIteratorRow method is:</p>
333 PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
334 size_t *number_wands)
337 <p>A description of each parameter follows:</p>
340 <p>the pixel iterator.</p>
342 <h5>number_wands</h5>
343 <p>the number of pixel wands.</p>
346 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelGetIteratorException">PixelGetIteratorException</a></h2>
347 <div class="doc-section">
349 <p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
351 <p>The format of the PixelGetIteratorException method is:</p>
354 char *PixelGetIteratorException(const Pixeliterator *iterator,
355 ExceptionType *severity)
358 <p>A description of each parameter follows:</p>
361 <p>the pixel iterator.</p>
364 <p>the severity of the error is returned here.</p>
367 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a></h2>
368 <div class="doc-section">
370 <p>PixelGetIteratorExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p>
372 <p>The format of the PixelGetIteratorExceptionType method is:</p>
375 ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
378 <p>A description of each parameter follows:</p>
381 <p>the magick wand.</p>
384 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelGetIteratorRow">PixelGetIteratorRow</a></h2>
385 <div class="doc-section">
387 <p>PixelGetIteratorRow() returns the current pixel iterator row.</p>
389 <p>The format of the PixelGetIteratorRow method is:</p>
392 MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
395 <p>A description of each parameter follows:</p>
398 <p>the pixel iterator.</p>
401 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
402 <div class="doc-section">
404 <p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p>
406 <p>The format of the PixelGetNextIteratorRow method is:</p>
409 PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
410 size_t *number_wands)
413 <p>A description of each parameter follows:</p>
416 <p>the pixel iterator.</p>
418 <h5>number_wands</h5>
419 <p>the number of pixel wands.</p>
422 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
423 <div class="doc-section">
425 <p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p>
427 <p>The format of the PixelGetPreviousIteratorRow method is:</p>
430 PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
431 size_t *number_wands)
434 <p>A description of each parameter follows:</p>
437 <p>the pixel iterator.</p>
439 <h5>number_wands</h5>
440 <p>the number of pixel wands.</p>
443 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelResetIterator">PixelResetIterator</a></h2>
444 <div class="doc-section">
446 <p>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.</p>
448 <p>The format of the PixelResetIterator method is:</p>
451 void PixelResetIterator(PixelIterator *iterator)
454 <p>A description of each parameter follows:</p>
457 <p>the pixel iterator.</p>
460 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
461 <div class="doc-section">
463 <p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p>
465 <p>The format of the PixelSetFirstIteratorRow method is:</p>
468 void PixelSetFirstIteratorRow(PixelIterator *iterator)
471 <p>A description of each parameter follows:</p>
474 <p>the magick iterator.</p>
477 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
478 <div class="doc-section">
480 <p>PixelSetIteratorRow() set the pixel iterator row.</p>
482 <p>The format of the PixelSetIteratorRow method is:</p>
485 MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
489 <p>A description of each parameter follows:</p>
492 <p>the pixel iterator.</p>
495 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
496 <div class="doc-section">
498 <p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p>
500 <p>The format of the PixelSetLastIteratorRow method is:</p>
503 void PixelSetLastIteratorRow(PixelIterator *iterator)
506 <p>A description of each parameter follows:</p>
509 <p>the magick iterator.</p>
512 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator_8c.html" id="PixelSyncIterator">PixelSyncIterator</a></h2>
513 <div class="doc-section">
515 <p>PixelSyncIterator() syncs the pixel iterator.</p>
517 <p>The format of the PixelSyncIterator method is:</p>
520 MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
523 <p>A description of each parameter follows:</p>
526 <p>the pixel iterator.</p>
533 <span id="linkbar-west"> </span>
\r
534 <span id="linkbar-center">
\r
535 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
536 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
538 <span id="linkbar-east"> </span>
\r
540 <div class="footer">
\r
541 <span id="footer-west">© 1999-2011 ImageMagick Studio LLC</span>
\r
542 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
544 <div style="clear: both; margin: 0; width: 100%; "></div>
\r
545 <script type="text/javascript">
\r
546 var _gaq = _gaq || [];
\r
547 _gaq.push(['_setAccount', 'UA-17690367-1']);
\r
548 _gaq.push(['_trackPageview']);
\r
551 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
\r
552 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
\r
553 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
\r