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