blob: 0ce6f8d3f0e0164d820e728ba588836976cd314e [file] [log] [blame]
cristyf3bb4782009-09-08 13:10:04 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
7 <style type="text/css" media="screen,projection"><!--
8 @import url("../../www/magick.css");
9 --></style>
cristy3ed852e2009-09-05 21:47:34 +000010 <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"/>
cristyf3bb4782009-09-08 13:10:04 +000026</head>
27
28<body id="www-imagemagick-org">
29<div class="titlebar">
30<a href="../../index.html">
31 <img src="../../images/script.png" alt="[ImageMagick]"
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
33<a href="http://www.networkredux.com">
34 <img src="../../images/networkredux.png" alt="[sponsor]"
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
36<a href="http://www.imagemagick.org/discourse-server/">
37 <img src="../../images/logo.jpg" alt=""
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
39<a href="../../index.html">
40 <img src="../../images/sprite.jpg" alt=""
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
42</div>
43
44<div class="eastbar">
45
cristy3ed852e2009-09-05 21:47:34 +000046<div class="menu">
47 <a href="../../index.html">About ImageMagick</a>
48</div>
cristyf3bb4782009-09-08 13:10:04 +000049<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000050<div class="menu">
51 <a href="../../www/command-line-tools.html">Command-line Tools</a>
52</div>
53<div class="sub">
54 <a href="../../www/command-line-processing.html">Processing</a>
55</div>
56<div class="sub">
57 <a href="../../www/command-line-options.html">Options</a>
58</div>
59<div class="sub">
60 <a href="http://www.imagemagick.org/Usage/">Usage</a>
61</div>
62<div class="menu">
63 <a href="../../www/api.html">Program Interfaces</a>
64</div>
65<div class="sub">
66 <a href="../../www/magick-wand.html">MagickWand</a>
67</div>
68<div class="sub">
69 <a href="../../www/magick-core.html">MagickCore</a>
70</div>
71<div class="sub">
72 <a href="../../www/perl-magick.html">PerlMagick</a>
73</div>
74<div class="sub">
75 <a href="../../Magick++/">Magick++</a>
76</div>
77<div class="menu">
78 <a href="../../www/architecture.html">Architecture</a>
79</div>
cristyf3bb4782009-09-08 13:10:04 +000080<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000081<div class="menu">
82 <a href="../../www/install-source.html">Install from Source</a>
83</div>
84<div class="sub">
85 <a href="../../www/install-source.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a href="../../www/install-source.html#windows">Windows</a>
89 </div>
90<div class="menu">
91 <a href="../../www/binary-releases.html">Binary Releases</a>
92</div>
93<div class="sub">
94 <a href="../../www/binary-releases.html#unix">Unix</a>
95</div>
96<div class="sub">
97 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
98</div>
99<div class="sub">
100 <a href="../../www/binary-releases.html#windows">Windows</a>
101</div>
102<div class="menu">
103 <a href="../../www/resources.html">Resources</a>
104</div>
cristyf3bb4782009-09-08 13:10:04 +0000105<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000106<div class="menu">
107 <a href="../../www/download.html">Download</a>
108</div>
cristyf3bb4782009-09-08 13:10:04 +0000109<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000110<div class="menu">
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112</div>
cristyf3bb4782009-09-08 13:10:04 +0000113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000114<div class="menu">
115 <a href="../../www/sitemap.html">Site Map</a>
116</div>
117<div class="sub">
118 <a href="../../www/links.html">Links</a>
119</div>
cristyf3bb4782009-09-08 13:10:04 +0000120<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000121<div class="menu">
122 <a href="../../www/sponsors.html">Sponsors:</a>
123
124<div class="sponsbox">
125<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000126 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
127</div>
128<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000129 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
130</div>
131<div class="sponsor">
132 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
133</div>
134<div class="sponsor">
135 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
136</div>
137<div class="sponsor">
138 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
139</div>
140<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000141 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
cristy3ed852e2009-09-05 21:47:34 +0000142</div>
143</div>
144</div>
cristyf3bb4782009-09-08 13:10:04 +0000145
146
147</div>
148
149<div class="main">
150
cristy3ed852e2009-09-05 21:47:34 +0000151<p class="navigation-index">[<a href="#ClearPixelIterator">ClearPixelIterator</a> &bull; <a href="#ClonePixelIterator">ClonePixelIterator</a> &bull; <a href="#DestroyPixelIterator">DestroyPixelIterator</a> &bull; <a href="#IsPixelIterator">IsPixelIterator</a> &bull; <a href="#NewPixelIterator">NewPixelIterator</a> &bull; <a href="#PixelClearIteratorException">PixelClearIteratorException</a> &bull; <a href="#NewPixelRegionIterator">NewPixelRegionIterator</a> &bull; <a href="#PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a> &bull; <a href="#PixelGetIteratorException">PixelGetIteratorException</a> &bull; <a href="#PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a> &bull; <a href="#PixelGetIteratorRow">PixelGetIteratorRow</a> &bull; <a href="#PixelGetNextIteratorRow">PixelGetNextIteratorRow</a> &bull; <a href="#PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a> &bull; <a href="#PixelResetIterator">PixelResetIterator</a> &bull; <a href="#PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a> &bull; <a href="#PixelSetIteratorRow">PixelSetIteratorRow</a> &bull; <a href="#PixelSetLastIteratorRow">PixelSetLastIteratorRow</a> &bull; <a href="#PixelSyncIterator">PixelSyncIterator</a>]</p>
152
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">
156
157<p>ClearPixelIterator() clear resources associated with a PixelIterator.</p></ol>
158
159<p>The format of the ClearPixelIterator method is:</p>
160
161<pre class="code">
162 PixelIterator *ClearPixelIterator(PixelIterator *iterator)
163</pre>
164
165<p>A description of each parameter follows:</p></ol>
166
167<h5>iterator</h5>
168<ol><p>the pixel iterator.</p></ol>
169
170 </div>
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">
174
175<p>ClonePixelIterator() makes an exact copy of the specified iterator.</p></ol>
176
177<p>The format of the ClonePixelIterator method is:</p>
178
179<pre class="code">
180 PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
181</pre>
182
183<p>A description of each parameter follows:</p></ol>
184
185<h5>iterator</h5>
186<ol><p>the magick iterator.</p></ol>
187
188 </div>
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">
192
193<p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p></ol>
194
195<p>The format of the DestroyPixelIterator method is:</p>
196
197<pre class="code">
198 PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
199</pre>
200
201<p>A description of each parameter follows:</p></ol>
202
203<h5>iterator</h5>
204<ol><p>the pixel iterator.</p></ol>
205
206 </div>
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">
210
211<p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p></ol>
212
213<p>The format of the IsPixelIterator method is:</p>
214
215<pre class="code">
216 MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
217</pre>
218
219<p>A description of each parameter follows:</p></ol>
220
221<h5>iterator</h5>
222<ol><p>the magick iterator.</p></ol>
223
224 </div>
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">
228
229<p>NewPixelIterator() returns a new pixel iterator.</p></ol>
230
231<p>The format of the NewPixelIterator method is:</p>
232
233<pre class="code">
234 PixelIterator NewPixelIterator(MagickWand *wand)
235</pre>
236
237<p>A description of each parameter follows:</p></ol>
238
239<h5>wand</h5>
240<ol><p>the magick wand.</p></ol>
241
242 </div>
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">
246
247<p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p></ol>
248
249<p>The format of the PixelClearIteratorException method is:</p>
250
251<pre class="code">
252 MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
253</pre>
254
255<p>A description of each parameter follows:</p></ol>
256
257<h5>wand</h5>
258<ol><p>the pixel wand.</p></ol>
259
260 </div>
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">
264
265<p>NewPixelRegionIterator() returns a new pixel iterator.</p></ol>
266
267<p>The format of the NewPixelRegionIterator method is:</p>
268
269<pre class="code">
270 PixelIterator NewPixelRegionIterator(MagickWand *wand,const long x,
271 const long y,const unsigned long width,const unsigned long height)
272</pre>
273
274<p>A description of each parameter follows:</p></ol>
275
276<h5>wand</h5>
277<ol><p>the magick wand.</p></ol>
278
279<h5>x,y,columns,rows</h5>
280<ol><p>These values define the perimeter of a region of pixels.</p></ol>
281
282 </div>
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">
286
287<p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p></ol>
288
289<p>The format of the PixelGetCurrentIteratorRow method is:</p>
290
291<pre class="code">
292 PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
293 unsigned long *number_wands)
294</pre>
295
296<p>A description of each parameter follows:</p></ol>
297
298<h5>iterator</h5>
299<ol><p>the pixel iterator.</p></ol>
300
301<h5>number_wands</h5>
302<ol><p>the number of pixel wands.</p></ol>
303
304 </div>
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">
308
309<p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
310
311<p>The format of the PixelGetIteratorException method is:</p>
312
313<pre class="code">
314 char *PixelGetIteratorException(const Pixeliterator *iterator,
315 ExceptionType *severity)
316</pre>
317
318<p>A description of each parameter follows:</p></ol>
319
320<h5>iterator</h5>
321<ol><p>the pixel iterator.</p></ol>
322
323<h5>severity</h5>
324<ol><p>the severity of the error is returned here.</p></ol>
325
326 </div>
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">
330
331<p>PixelGetIteratorExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
332
333<p>The format of the PixelGetIteratorExceptionType method is:</p>
334
335<pre class="code">
336 ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
337</pre>
338
339<p>A description of each parameter follows:</p></ol>
340
341<h5>wand</h5>
342<ol><p>the magick wand.</p></ol>
343
344 </div>
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">
348
349<p>PixelGetIteratorRow() returns the current pixel iterator row.</p></ol>
350
351<p>The format of the PixelGetIteratorRow method is:</p>
352
353<pre class="code">
354 MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
355</pre>
356
357<p>A description of each parameter follows:</p></ol>
358
359<h5>iterator</h5>
360<ol><p>the pixel iterator.</p></ol>
361
362 </div>
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">
366
367<p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
368
369<p>The format of the PixelGetNextIteratorRow method is:</p>
370
371<pre class="code">
372 PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
373 unsigned long *number_wands)
374</pre>
375
376<p>A description of each parameter follows:</p></ol>
377
378<h5>iterator</h5>
379<ol><p>the pixel iterator.</p></ol>
380
381<h5>number_wands</h5>
382<ol><p>the number of pixel wands.</p></ol>
383
384 </div>
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">
388
389<p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p></ol>
390
391<p>The format of the PixelGetPreviousIteratorRow method is:</p>
392
393<pre class="code">
394 PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
395 unsigned long *number_wands)
396</pre>
397
398<p>A description of each parameter follows:</p></ol>
399
400<h5>iterator</h5>
401<ol><p>the pixel iterator.</p></ol>
402
403<h5>number_wands</h5>
404<ol><p>the number of pixel wands.</p></ol>
405
406 </div>
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">
410
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>
412
413<p>The format of the PixelResetIterator method is:</p>
414
415<pre class="code">
416 void PixelResetIterator(PixelIterator *iterator)
417</pre>
418
419<p>A description of each parameter follows:</p></ol>
420
421<h5>iterator</h5>
422<ol><p>the pixel iterator.</p></ol>
423
424 </div>
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">
428
429<p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p></ol>
430
431<p>The format of the PixelSetFirstIteratorRow method is:</p>
432
433<pre class="code">
434 void PixelSetFirstIteratorRow(PixelIterator *iterator)
435</pre>
436
437<p>A description of each parameter follows:</p></ol>
438
439<h5>iterator</h5>
440<ol><p>the magick iterator.</p></ol>
441
442 </div>
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">
446
447<p>PixelSetIteratorRow() set the pixel iterator row.</p></ol>
448
449<p>The format of the PixelSetIteratorRow method is:</p>
450
451<pre class="code">
452 MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
453 const long row)
454</pre>
455
456<p>A description of each parameter follows:</p></ol>
457
458<h5>iterator</h5>
459<ol><p>the pixel iterator.</p></ol>
460
461 </div>
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">
465
466<p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p></ol>
467
468<p>The format of the PixelSetLastIteratorRow method is:</p>
469
470<pre class="code">
471 void PixelSetLastIteratorRow(PixelIterator *iterator)
472</pre>
473
474<p>A description of each parameter follows:</p></ol>
475
476<h5>iterator</h5>
477<ol><p>the magick iterator.</p></ol>
478
479 </div>
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">
483
484<p>PixelSyncIterator() syncs the pixel iterator.</p></ol>
485
486<p>The format of the PixelSyncIterator method is:</p>
487
488<pre class="code">
489 MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
490</pre>
491
492<p>A description of each parameter follows:</p></ol>
493
494<h5>iterator</h5>
495<ol><p>the pixel iterator.</p></ol>
496
497 </div>
cristyf3bb4782009-09-08 13:10:04 +0000498
499</div>
500
501<div id="linkbar">
502 <!-- <span id="linkbar-west">&nbsp;</span> -->
503 <span id="linkbar-center">
504 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
505 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
506 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
507 </span>
508 <span id="linkbar-east">&nbsp;</span>
509 </div>
510 <div class="footer">
511 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
512 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
513 </div>
514 <div style="clear: both; margin: 0; width: 100%; "></div>
515</body>
516</html>