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