blob: 9d1b3f850856f56453184cd37bf7922cf967d9ac [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">
cristyb14e29e2009-11-03 17:20:00 +0000126 <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20090501000200 -->
cristyc1c61662009-09-30 14:04:37 +0000127</div>
128<div class="sponsor">
cristy916e1922009-10-01 12:52:47 +0000129 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
130</div>
131<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000132 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
133</div>
134<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000135 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
136</div>
137<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000138 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
139</div>
140<div class="sponsor">
141 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
142</div>
143<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000144 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
145</div>
cristy3ed852e2009-09-05 21:47:34 +0000146</div>
147</div>
cristyf3bb4782009-09-08 13:10:04 +0000148
149
150</div>
151
152<div class="main">
153
cristy3ed852e2009-09-05 21:47:34 +0000154<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>
155
156<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
157_8c.html" target="source" name="ClearPixelIterator">ClearPixelIterator</a></h2>
158<div class="doc-section">
159
160<p>ClearPixelIterator() clear resources associated with a PixelIterator.</p></ol>
161
162<p>The format of the ClearPixelIterator method is:</p>
163
164<pre class="code">
165 PixelIterator *ClearPixelIterator(PixelIterator *iterator)
166</pre>
167
168<p>A description of each parameter follows:</p></ol>
169
170<h5>iterator</h5>
171<ol><p>the pixel iterator.</p></ol>
172
173 </div>
174<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
175_8c.html" target="source" name="ClonePixelIterator">ClonePixelIterator</a></h2>
176<div class="doc-section">
177
178<p>ClonePixelIterator() makes an exact copy of the specified iterator.</p></ol>
179
180<p>The format of the ClonePixelIterator method is:</p>
181
182<pre class="code">
183 PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
184</pre>
185
186<p>A description of each parameter follows:</p></ol>
187
188<h5>iterator</h5>
189<ol><p>the magick iterator.</p></ol>
190
191 </div>
192<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
193_8c.html" target="source" name="DestroyPixelIterator">DestroyPixelIterator</a></h2>
194<div class="doc-section">
195
196<p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p></ol>
197
198<p>The format of the DestroyPixelIterator method is:</p>
199
200<pre class="code">
201 PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
202</pre>
203
204<p>A description of each parameter follows:</p></ol>
205
206<h5>iterator</h5>
207<ol><p>the pixel iterator.</p></ol>
208
209 </div>
210<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
211_8c.html" target="source" name="IsPixelIterator">IsPixelIterator</a></h2>
212<div class="doc-section">
213
214<p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p></ol>
215
216<p>The format of the IsPixelIterator method is:</p>
217
218<pre class="code">
219 MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
220</pre>
221
222<p>A description of each parameter follows:</p></ol>
223
224<h5>iterator</h5>
225<ol><p>the magick iterator.</p></ol>
226
227 </div>
228<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
229_8c.html" target="source" name="NewPixelIterator">NewPixelIterator</a></h2>
230<div class="doc-section">
231
232<p>NewPixelIterator() returns a new pixel iterator.</p></ol>
233
234<p>The format of the NewPixelIterator method is:</p>
235
236<pre class="code">
237 PixelIterator NewPixelIterator(MagickWand *wand)
238</pre>
239
240<p>A description of each parameter follows:</p></ol>
241
242<h5>wand</h5>
243<ol><p>the magick wand.</p></ol>
244
245 </div>
246<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
247_8c.html" target="source" name="PixelClearIteratorException">PixelClearIteratorException</a></h2>
248<div class="doc-section">
249
250<p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p></ol>
251
252<p>The format of the PixelClearIteratorException method is:</p>
253
254<pre class="code">
255 MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
256</pre>
257
258<p>A description of each parameter follows:</p></ol>
259
260<h5>wand</h5>
261<ol><p>the pixel wand.</p></ol>
262
263 </div>
264<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
265_8c.html" target="source" name="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
266<div class="doc-section">
267
268<p>NewPixelRegionIterator() returns a new pixel iterator.</p></ol>
269
270<p>The format of the NewPixelRegionIterator method is:</p>
271
272<pre class="code">
273 PixelIterator NewPixelRegionIterator(MagickWand *wand,const long x,
274 const long y,const unsigned long width,const unsigned long height)
275</pre>
276
277<p>A description of each parameter follows:</p></ol>
278
279<h5>wand</h5>
280<ol><p>the magick wand.</p></ol>
281
282<h5>x,y,columns,rows</h5>
283<ol><p>These values define the perimeter of a region of pixels.</p></ol>
284
285 </div>
286<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
287_8c.html" target="source" name="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
288<div class="doc-section">
289
290<p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p></ol>
291
292<p>The format of the PixelGetCurrentIteratorRow method is:</p>
293
294<pre class="code">
295 PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
296 unsigned long *number_wands)
297</pre>
298
299<p>A description of each parameter follows:</p></ol>
300
301<h5>iterator</h5>
302<ol><p>the pixel iterator.</p></ol>
303
304<h5>number_wands</h5>
305<ol><p>the number of pixel wands.</p></ol>
306
307 </div>
308<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
309_8c.html" target="source" name="PixelGetIteratorException">PixelGetIteratorException</a></h2>
310<div class="doc-section">
311
312<p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
313
314<p>The format of the PixelGetIteratorException method is:</p>
315
316<pre class="code">
317 char *PixelGetIteratorException(const Pixeliterator *iterator,
318 ExceptionType *severity)
319</pre>
320
321<p>A description of each parameter follows:</p></ol>
322
323<h5>iterator</h5>
324<ol><p>the pixel iterator.</p></ol>
325
326<h5>severity</h5>
327<ol><p>the severity of the error is returned here.</p></ol>
328
329 </div>
330<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
331_8c.html" target="source" name="PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a></h2>
332<div class="doc-section">
333
334<p>PixelGetIteratorExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
335
336<p>The format of the PixelGetIteratorExceptionType method is:</p>
337
338<pre class="code">
339 ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
340</pre>
341
342<p>A description of each parameter follows:</p></ol>
343
344<h5>wand</h5>
345<ol><p>the magick wand.</p></ol>
346
347 </div>
348<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
349_8c.html" target="source" name="PixelGetIteratorRow">PixelGetIteratorRow</a></h2>
350<div class="doc-section">
351
352<p>PixelGetIteratorRow() returns the current pixel iterator row.</p></ol>
353
354<p>The format of the PixelGetIteratorRow method is:</p>
355
356<pre class="code">
357 MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
358</pre>
359
360<p>A description of each parameter follows:</p></ol>
361
362<h5>iterator</h5>
363<ol><p>the pixel iterator.</p></ol>
364
365 </div>
366<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
367_8c.html" target="source" name="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
368<div class="doc-section">
369
370<p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
371
372<p>The format of the PixelGetNextIteratorRow method is:</p>
373
374<pre class="code">
375 PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
376 unsigned long *number_wands)
377</pre>
378
379<p>A description of each parameter follows:</p></ol>
380
381<h5>iterator</h5>
382<ol><p>the pixel iterator.</p></ol>
383
384<h5>number_wands</h5>
385<ol><p>the number of pixel wands.</p></ol>
386
387 </div>
388<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
389_8c.html" target="source" name="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
390<div class="doc-section">
391
392<p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p></ol>
393
394<p>The format of the PixelGetPreviousIteratorRow method is:</p>
395
396<pre class="code">
397 PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
398 unsigned long *number_wands)
399</pre>
400
401<p>A description of each parameter follows:</p></ol>
402
403<h5>iterator</h5>
404<ol><p>the pixel iterator.</p></ol>
405
406<h5>number_wands</h5>
407<ol><p>the number of pixel wands.</p></ol>
408
409 </div>
410<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
411_8c.html" target="source" name="PixelResetIterator">PixelResetIterator</a></h2>
412<div class="doc-section">
413
414<p>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.</p></ol>
415
416<p>The format of the PixelResetIterator method is:</p>
417
418<pre class="code">
419 void PixelResetIterator(PixelIterator *iterator)
420</pre>
421
422<p>A description of each parameter follows:</p></ol>
423
424<h5>iterator</h5>
425<ol><p>the pixel iterator.</p></ol>
426
427 </div>
428<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
429_8c.html" target="source" name="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
430<div class="doc-section">
431
432<p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p></ol>
433
434<p>The format of the PixelSetFirstIteratorRow method is:</p>
435
436<pre class="code">
437 void PixelSetFirstIteratorRow(PixelIterator *iterator)
438</pre>
439
440<p>A description of each parameter follows:</p></ol>
441
442<h5>iterator</h5>
443<ol><p>the magick iterator.</p></ol>
444
445 </div>
446<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
447_8c.html" target="source" name="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
448<div class="doc-section">
449
450<p>PixelSetIteratorRow() set the pixel iterator row.</p></ol>
451
452<p>The format of the PixelSetIteratorRow method is:</p>
453
454<pre class="code">
455 MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
456 const long row)
457</pre>
458
459<p>A description of each parameter follows:</p></ol>
460
461<h5>iterator</h5>
462<ol><p>the pixel iterator.</p></ol>
463
464 </div>
465<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
466_8c.html" target="source" name="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
467<div class="doc-section">
468
469<p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p></ol>
470
471<p>The format of the PixelSetLastIteratorRow method is:</p>
472
473<pre class="code">
474 void PixelSetLastIteratorRow(PixelIterator *iterator)
475</pre>
476
477<p>A description of each parameter follows:</p></ol>
478
479<h5>iterator</h5>
480<ol><p>the magick iterator.</p></ol>
481
482 </div>
483<h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
484_8c.html" target="source" name="PixelSyncIterator">PixelSyncIterator</a></h2>
485<div class="doc-section">
486
487<p>PixelSyncIterator() syncs the pixel iterator.</p></ol>
488
489<p>The format of the PixelSyncIterator method is:</p>
490
491<pre class="code">
492 MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
493</pre>
494
495<p>A description of each parameter follows:</p></ol>
496
497<h5>iterator</h5>
498<ol><p>the pixel iterator.</p></ol>
499
500 </div>
cristyf3bb4782009-09-08 13:10:04 +0000501
502</div>
503
504<div id="linkbar">
505 <!-- <span id="linkbar-west">&nbsp;</span> -->
506 <span id="linkbar-center">
507 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
508 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
cristyd820f622009-11-03 03:46:48 +0000509 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristyf3bb4782009-09-08 13:10:04 +0000510 </span>
511 <span id="linkbar-east">&nbsp;</span>
512 </div>
513 <div class="footer">
514 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
515 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
516 </div>
517 <div style="clear: both; margin: 0; width: 100%; "></div>
518</body>
519</html>