]> granicus.if.org Git - imagemagick/blob - www/api/pixel-iterator.html
3fe5ac915b27d81e07aad463f90d63d7df3985bd
[imagemagick] / www / api / pixel-iterator.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
4 <head>\r
5   <meta http-equiv="Content-Type" value="application/xhtml+xml" />\r
6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
7   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
8   <style type="text/css" media="screen,projection"><!--\r
9     @import url("../../www/magick.css");\r
10   --></style>\r
11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
12   <title>ImageMagick: MagickWand, C API for ImageMagick: Pixel Iterator Methods</title>
13   <meta http-equiv="Content-Language" content="en-US"/>
14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16   <meta name="Generator" content="PHP"/>
17   <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"/>
18   <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."/>
19   <meta name="Rating" content="GENERAL"/>
20   <meta name="Robots" content="INDEX, FOLLOW"/>
21   <meta name="Generator" content="ImageMagick Studio LLC"/>
22   <meta name="Author" content="ImageMagick Studio LLC"/>
23   <meta name="Revisit-after" content="2 DAYS"/>
24   <meta name="Resource-type" content="document"/>
25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
26   <meta name="Distribution" content="Global"/>
27 </head>\r
28 \r
29 <body id="www-imagemagick-org">\r
30 <div class="titlebar">\r
31 <a href="../../index.html">\r
32   <img src="../../images/script.png" alt="[ImageMagick]"\r
33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
34 <a href="http://www.networkredux.com">\r
35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
37 <a href="http://www.imagemagick.org/discourse-server/">\r
38   <img src="../../images/logo.jpg" alt=""\r
39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
40 <a href="../../index.html">\r
41   <img src="../../images/sprite.jpg" alt=""\r
42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
43 </div>\r
44 \r
45 <div class="eastbar">\r
46 \r
47 <div class="menu">
48   <a href="../../index.html">About ImageMagick</a>
49 </div>
50 <div class="sep"></div>\r
51 <div class="menu">
52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
53 </div>
54 <div class="sub">
55     <a href="../../www/command-line-processing.html">Processing</a>
56 </div>
57 <div class="sub">
58     <a href="../../www/command-line-options.html">Options</a>
59 </div>
60 <div class="sub">
61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
62 </div>
63 <div class="menu">
64   <a href="../../www/api.html">Program Interfaces</a>
65 </div>
66 <div class="sub">
67     <a href="../../www/magick-wand.html">MagickWand</a>
68 </div>
69 <div class="sub">
70     <a href="../../www/magick-core.html">MagickCore</a>
71 </div>
72 <div class="sub">
73     <a href="../../www/perl-magick.html">PerlMagick</a>
74 </div>
75 <div class="sub">
76     <a href="../../Magick++/">Magick++</a>
77 </div>
78 <div class="menu">
79   <a href="../../www/architecture.html">Architecture</a>
80 </div>
81 <div class="sep"></div>\r
82 <div  class="menu">
83    <a href="../../www/install-source.html">Install from Source</a>
84 </div>
85 <div class="sub">
86     <a href="../../www/install-source.html#unix">Unix</a>
87 </div>
88 <div class="sub">
89     <a href="../../www/install-source.html#windows">Windows</a>
90  </div>
91 <div class="menu">
92   <a href="../../www/binary-releases.html">Binary Releases</a>
93 </div>
94 <div class="sub">
95     <a href="../../www/binary-releases.html#unix">Unix</a>
96 </div>
97 <div class="sub">
98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
99 </div>
100 <div class="sub">
101     <a href="../../www/binary-releases.html#windows">Windows</a>
102 </div>
103 <div class="menu">
104   <a href="../../www/resources.html">Resources</a>
105 </div>
106 <div class="sep"></div>\r
107 <div class="menu">
108   <a href="../../www/download.html">Download</a>
109 </div>
110 <div class="sep"></div>\r
111 <div class="menu">
112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113 </div>
114 <div class="sep"></div>\r
115 <div class="menu">
116   <a href="../../www/sitemap.html">Site Map</a>
117 </div>
118 <div  class="sub">
119     <a href="../../www/links.html">Links</a>
120 </div>
121 <div class="sep"></div>\r
122 <div  class="menu">
123   <a href="../../www/sponsors.html">Sponsors:</a>
124
125 <div class="sponsbox">
126 <div  class="sponsor">
127    <a href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
128 </div>
129 <div  class="sponsor">
130   <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
131 </div>
132 <div  class="sponsor">
133   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
134 </div>
135 <div  class="sponsor">
136   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
137 </div>
138 <div  class="sponsor">
139   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
140 </div>
141 <div  class="sponsor">
142   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
143 </div>
144 <div  class="sponsor">
145    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
146 </div>
147 <div  class="sponsor">
148    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
149 </div>
150 </div>
151 </div>
152 \r
153 \r
154 </div>\r
155 \r
156 <div class="main">\r
157 \r
158 <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>
159
160 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
161 _8c.html" target="source" name="ClearPixelIterator">ClearPixelIterator</a></h2>
162 <div class="doc-section">
163
164 <p>ClearPixelIterator() clear resources associated with a PixelIterator.</p></ol>
165
166 <p>The format of the ClearPixelIterator method is:</p>
167
168 <pre class="code">
169   PixelIterator *ClearPixelIterator(PixelIterator *iterator)
170 </pre>
171
172 <p>A description of each parameter follows:</p></ol>
173
174 <h5>iterator</h5>
175 <ol><p>the pixel iterator.</p></ol>
176
177  </div>
178 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
179 _8c.html" target="source" name="ClonePixelIterator">ClonePixelIterator</a></h2>
180 <div class="doc-section">
181
182 <p>ClonePixelIterator() makes an exact copy of the specified iterator.</p></ol>
183
184 <p>The format of the ClonePixelIterator method is:</p>
185
186 <pre class="code">
187   PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
188 </pre>
189
190 <p>A description of each parameter follows:</p></ol>
191
192 <h5>iterator</h5>
193 <ol><p>the magick iterator.</p></ol>
194
195  </div>
196 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
197 _8c.html" target="source" name="DestroyPixelIterator">DestroyPixelIterator</a></h2>
198 <div class="doc-section">
199
200 <p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p></ol>
201
202 <p>The format of the DestroyPixelIterator method is:</p>
203
204 <pre class="code">
205   PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
206 </pre>
207
208 <p>A description of each parameter follows:</p></ol>
209
210 <h5>iterator</h5>
211 <ol><p>the pixel iterator.</p></ol>
212
213  </div>
214 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
215 _8c.html" target="source" name="IsPixelIterator">IsPixelIterator</a></h2>
216 <div class="doc-section">
217
218 <p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p></ol>
219
220 <p>The format of the IsPixelIterator method is:</p>
221
222 <pre class="code">
223   MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
224 </pre>
225
226 <p>A description of each parameter follows:</p></ol>
227
228 <h5>iterator</h5>
229 <ol><p>the magick iterator.</p></ol>
230
231  </div>
232 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
233 _8c.html" target="source" name="NewPixelIterator">NewPixelIterator</a></h2>
234 <div class="doc-section">
235
236 <p>NewPixelIterator() returns a new pixel iterator.</p></ol>
237
238 <p>The format of the NewPixelIterator method is:</p>
239
240 <pre class="code">
241   PixelIterator NewPixelIterator(MagickWand *wand)
242 </pre>
243
244 <p>A description of each parameter follows:</p></ol>
245
246 <h5>wand</h5>
247 <ol><p>the magick wand.</p></ol>
248
249  </div>
250 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
251 _8c.html" target="source" name="PixelClearIteratorException">PixelClearIteratorException</a></h2>
252 <div class="doc-section">
253
254 <p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p></ol>
255
256 <p>The format of the PixelClearIteratorException method is:</p>
257
258 <pre class="code">
259   MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
260 </pre>
261
262 <p>A description of each parameter follows:</p></ol>
263
264 <h5>wand</h5>
265 <ol><p>the pixel wand.</p></ol>
266
267  </div>
268 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
269 _8c.html" target="source" name="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
270 <div class="doc-section">
271
272 <p>NewPixelRegionIterator() returns a new pixel iterator.</p></ol>
273
274 <p>The format of the NewPixelRegionIterator method is:</p>
275
276 <pre class="code">
277   PixelIterator NewPixelRegionIterator(MagickWand *wand,const long x,
278     const long y,const unsigned long width,const unsigned long height)
279 </pre>
280
281 <p>A description of each parameter follows:</p></ol>
282
283 <h5>wand</h5>
284 <ol><p>the magick wand.</p></ol>
285
286 <h5>x,y,columns,rows</h5>
287 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
288
289  </div>
290 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
291 _8c.html" target="source" name="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
292 <div class="doc-section">
293
294 <p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p></ol>
295
296 <p>The format of the PixelGetCurrentIteratorRow method is:</p>
297
298 <pre class="code">
299   PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
300     unsigned long *number_wands)
301 </pre>
302
303 <p>A description of each parameter follows:</p></ol>
304
305 <h5>iterator</h5>
306 <ol><p>the pixel iterator.</p></ol>
307
308 <h5>number_wands</h5>
309 <ol><p>the number of pixel wands.</p></ol>
310
311  </div>
312 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
313 _8c.html" target="source" name="PixelGetIteratorException">PixelGetIteratorException</a></h2>
314 <div class="doc-section">
315
316 <p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p></ol>
317
318 <p>The format of the PixelGetIteratorException method is:</p>
319
320 <pre class="code">
321   char *PixelGetIteratorException(const Pixeliterator *iterator,
322     ExceptionType *severity)
323 </pre>
324
325 <p>A description of each parameter follows:</p></ol>
326
327 <h5>iterator</h5>
328 <ol><p>the pixel iterator.</p></ol>
329
330 <h5>severity</h5>
331 <ol><p>the severity of the error is returned here.</p></ol>
332
333  </div>
334 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
335 _8c.html" target="source" name="PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a></h2>
336 <div class="doc-section">
337
338 <p>PixelGetIteratorExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p></ol>
339
340 <p>The format of the PixelGetIteratorExceptionType method is:</p>
341
342 <pre class="code">
343   ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
344 </pre>
345
346 <p>A description of each parameter follows:</p></ol>
347
348 <h5>wand</h5>
349 <ol><p>the magick wand.</p></ol>
350
351  </div>
352 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
353 _8c.html" target="source" name="PixelGetIteratorRow">PixelGetIteratorRow</a></h2>
354 <div class="doc-section">
355
356 <p>PixelGetIteratorRow() returns the current pixel iterator row.</p></ol>
357
358 <p>The format of the PixelGetIteratorRow method is:</p>
359
360 <pre class="code">
361   MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
362 </pre>
363
364 <p>A description of each parameter follows:</p></ol>
365
366 <h5>iterator</h5>
367 <ol><p>the pixel iterator.</p></ol>
368
369  </div>
370 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
371 _8c.html" target="source" name="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
372 <div class="doc-section">
373
374 <p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p></ol>
375
376 <p>The format of the PixelGetNextIteratorRow method is:</p>
377
378 <pre class="code">
379   PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
380     unsigned long *number_wands)
381 </pre>
382
383 <p>A description of each parameter follows:</p></ol>
384
385 <h5>iterator</h5>
386 <ol><p>the pixel iterator.</p></ol>
387
388 <h5>number_wands</h5>
389 <ol><p>the number of pixel wands.</p></ol>
390
391  </div>
392 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
393 _8c.html" target="source" name="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
394 <div class="doc-section">
395
396 <p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p></ol>
397
398 <p>The format of the PixelGetPreviousIteratorRow method is:</p>
399
400 <pre class="code">
401   PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
402     unsigned long *number_wands)
403 </pre>
404
405 <p>A description of each parameter follows:</p></ol>
406
407 <h5>iterator</h5>
408 <ol><p>the pixel iterator.</p></ol>
409
410 <h5>number_wands</h5>
411 <ol><p>the number of pixel wands.</p></ol>
412
413  </div>
414 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
415 _8c.html" target="source" name="PixelResetIterator">PixelResetIterator</a></h2>
416 <div class="doc-section">
417
418 <p>PixelResetIterator() resets the pixel iterator.  Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.</p></ol>
419
420 <p>The format of the PixelResetIterator method is:</p>
421
422 <pre class="code">
423   void PixelResetIterator(PixelIterator *iterator)
424 </pre>
425
426 <p>A description of each parameter follows:</p></ol>
427
428 <h5>iterator</h5>
429 <ol><p>the pixel iterator.</p></ol>
430
431  </div>
432 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
433 _8c.html" target="source" name="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
434 <div class="doc-section">
435
436 <p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p></ol>
437
438 <p>The format of the PixelSetFirstIteratorRow method is:</p>
439
440 <pre class="code">
441   void PixelSetFirstIteratorRow(PixelIterator *iterator)
442 </pre>
443
444 <p>A description of each parameter follows:</p></ol>
445
446 <h5>iterator</h5>
447 <ol><p>the magick iterator.</p></ol>
448
449  </div>
450 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
451 _8c.html" target="source" name="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
452 <div class="doc-section">
453
454 <p>PixelSetIteratorRow() set the pixel iterator row.</p></ol>
455
456 <p>The format of the PixelSetIteratorRow method is:</p>
457
458 <pre class="code">
459   MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
460     const long row)
461 </pre>
462
463 <p>A description of each parameter follows:</p></ol>
464
465 <h5>iterator</h5>
466 <ol><p>the pixel iterator.</p></ol>
467
468  </div>
469 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
470 _8c.html" target="source" name="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
471 <div class="doc-section">
472
473 <p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p></ol>
474
475 <p>The format of the PixelSetLastIteratorRow method is:</p>
476
477 <pre class="code">
478   void PixelSetLastIteratorRow(PixelIterator *iterator)
479 </pre>
480
481 <p>A description of each parameter follows:</p></ol>
482
483 <h5>iterator</h5>
484 <ol><p>the magick iterator.</p></ol>
485
486  </div>
487 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-iterator
488 _8c.html" target="source" name="PixelSyncIterator">PixelSyncIterator</a></h2>
489 <div class="doc-section">
490
491 <p>PixelSyncIterator() syncs the pixel iterator.</p></ol>
492
493 <p>The format of the PixelSyncIterator method is:</p>
494
495 <pre class="code">
496   MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
497 </pre>
498
499 <p>A description of each parameter follows:</p></ol>
500
501 <h5>iterator</h5>
502 <ol><p>the pixel iterator.</p></ol>
503
504  </div>
505 \r
506 </div>\r
507 \r
508 <div id="linkbar">\r
509  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
510     <span id="linkbar-center">\r
511       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
512     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
513     </span>\r
514     <span id="linkbar-east">&nbsp;</span>\r
515   </div>\r
516   <div class="footer">\r
517     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
518     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
519   </div>\r
520   <div style="clear: both; margin: 0; width: 100%; "></div>\r
521 </body>\r
522 </html>\r