Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / b320d0780c0188f3d7c2a96a40522df9e37177f2 / . / www / api / pixel-iterator.html
blob: 3c2f779ce6c25fda54ebac9b2007a9472be4a646 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickWand, C API for ImageMagick: Pixel Iterator Methods</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <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"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]27 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]28 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]31 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]32 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]44</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]53 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]54<a href="http://www.imagemagick.org/discourse-server/">
55 <img src="../../images/logo.jpg" alt=""
56 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
57<a href="../../index.html">
58 <img src="../../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]62<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]63
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]67<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]69 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]82 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]83</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]85 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]86</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]88 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]89</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]106 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]121<div class="menu">
122 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]129 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]133 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]136 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]140 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141
142<div class="sponsbox">
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]143<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]144 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]145</div>
146<div class="sponsor">
147 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]155<div class="sponsor">
cristye855cb32011-01-16 02:13:10 +0000[diff] [blame]156 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011050100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]157</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]158</div>
159</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]160</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]161
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]162<div class="eastbar">
163 <script type="text/javascript">
164 <!--
165 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]166 google_ad_slot = "0574824969";
167 google_ad_width = 160;
168 google_ad_height = 600;
169 //-->
170 </script>
171 <script type="text/javascript"
172 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
173 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]174</div>
175
176<div class="main">
177
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]178<h1>Module pixel-iterator
179 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]180<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>
181
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]182<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
183_8c.html" id="ClearPixelIterator">ClearPixelIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]184<div class="doc-section">
185
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]186<p>ClearPixelIterator() clear resources associated with a PixelIterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]187
188<p>The format of the ClearPixelIterator method is:</p>
189
190<pre class="code">
191 PixelIterator *ClearPixelIterator(PixelIterator *iterator)
192</pre>
193
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]194<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]195
196<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]197<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]198
199 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]200<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
201_8c.html" id="ClonePixelIterator">ClonePixelIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]202<div class="doc-section">
203
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]204<p>ClonePixelIterator() makes an exact copy of the specified iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]205
206<p>The format of the ClonePixelIterator method is:</p>
207
208<pre class="code">
209 PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
210</pre>
211
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]212<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]213
214<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]215<p>the magick iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]216
217 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]218<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
219_8c.html" id="DestroyPixelIterator">DestroyPixelIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]220<div class="doc-section">
221
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]222<p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]223
224<p>The format of the DestroyPixelIterator method is:</p>
225
226<pre class="code">
227 PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
228</pre>
229
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]230<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]231
232<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]233<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]234
235 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]236<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
237_8c.html" id="IsPixelIterator">IsPixelIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]238<div class="doc-section">
239
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]240<p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]241
242<p>The format of the IsPixelIterator method is:</p>
243
244<pre class="code">
245 MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
246</pre>
247
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]248<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]249
250<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]251<p>the magick iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]252
253 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]254<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
255_8c.html" id="NewPixelIterator">NewPixelIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]256<div class="doc-section">
257
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]258<p>NewPixelIterator() returns a new pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]259
260<p>The format of the NewPixelIterator method is:</p>
261
262<pre class="code">
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]263 PixelIterator *NewPixelIterator(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]264</pre>
265
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]266<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]267
268<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]269<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]270
271 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]272<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
273_8c.html" id="PixelClearIteratorException">PixelClearIteratorException</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]274<div class="doc-section">
275
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]276<p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]277
278<p>The format of the PixelClearIteratorException method is:</p>
279
280<pre class="code">
281 MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
282</pre>
283
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]284<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]285
286<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]287<p>the pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]288
289 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]290<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
291_8c.html" id="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]292<div class="doc-section">
293
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]294<p>NewPixelRegionIterator() returns a new pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]295
296<p>The format of the NewPixelRegionIterator method is:</p>
297
298<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]299 PixelIterator NewPixelRegionIterator(MagickWand *wand,const ssize_t x,
300 const ssize_t y,const size_t width,const size_t height)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]301</pre>
302
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]303<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]304
305<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]306<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]307
308<h5>x,y,columns,rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]309<p>These values define the perimeter of a region of pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]310
311 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]312<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
313_8c.html" id="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]314<div class="doc-section">
315
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]316<p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]317
318<p>The format of the PixelGetCurrentIteratorRow method is:</p>
319
320<pre class="code">
321 PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]322 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]323</pre>
324
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]325<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]326
327<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]328<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]329
330<h5>number_wands</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]331<p>the number of pixel wands.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]332
333 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]334<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
335_8c.html" id="PixelGetIteratorException">PixelGetIteratorException</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]336<div class="doc-section">
337
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]338<p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]339
340<p>The format of the PixelGetIteratorException method is:</p>
341
342<pre class="code">
343 char *PixelGetIteratorException(const Pixeliterator *iterator,
344 ExceptionType *severity)
345</pre>
346
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]347<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]348
349<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]350<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]351
352<h5>severity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]353<p>the severity of the error is returned here.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]354
355 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]356<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
357_8c.html" id="PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]358<div class="doc-section">
359
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]360<p>PixelGetIteratorExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]361
362<p>The format of the PixelGetIteratorExceptionType method is:</p>
363
364<pre class="code">
365 ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
366</pre>
367
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]368<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]369
370<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]371<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]372
373 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]374<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
375_8c.html" id="PixelGetIteratorRow">PixelGetIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]376<div class="doc-section">
377
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]378<p>PixelGetIteratorRow() returns the current pixel iterator row.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]379
380<p>The format of the PixelGetIteratorRow method is:</p>
381
382<pre class="code">
383 MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
384</pre>
385
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]386<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]387
388<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]389<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]390
391 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]392<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
393_8c.html" id="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]394<div class="doc-section">
395
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]396<p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]397
398<p>The format of the PixelGetNextIteratorRow method is:</p>
399
400<pre class="code">
401 PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]402 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]403</pre>
404
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]405<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]406
407<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]408<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]409
410<h5>number_wands</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]411<p>the number of pixel wands.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]412
413 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]414<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
415_8c.html" id="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]416<div class="doc-section">
417
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]418<p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]419
420<p>The format of the PixelGetPreviousIteratorRow method is:</p>
421
422<pre class="code">
423 PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]424 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]425</pre>
426
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]427<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]428
429<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]430<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]431
432<h5>number_wands</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]433<p>the number of pixel wands.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]434
435 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]436<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
437_8c.html" id="PixelResetIterator">PixelResetIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]438<div class="doc-section">
439
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]440<p>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]441
442<p>The format of the PixelResetIterator method is:</p>
443
444<pre class="code">
445 void PixelResetIterator(PixelIterator *iterator)
446</pre>
447
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]448<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]449
450<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]451<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]452
453 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]454<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
455_8c.html" id="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]456<div class="doc-section">
457
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]458<p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]459
460<p>The format of the PixelSetFirstIteratorRow method is:</p>
461
462<pre class="code">
463 void PixelSetFirstIteratorRow(PixelIterator *iterator)
464</pre>
465
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]466<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]467
468<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]469<p>the magick iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]470
471 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]472<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
473_8c.html" id="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]474<div class="doc-section">
475
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]476<p>PixelSetIteratorRow() set the pixel iterator row.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]477
478<p>The format of the PixelSetIteratorRow method is:</p>
479
480<pre class="code">
481 MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]482 const ssize_t row)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]483</pre>
484
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]485<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]486
487<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]488<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]489
490 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]491<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
492_8c.html" id="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]493<div class="doc-section">
494
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]495<p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]496
497<p>The format of the PixelSetLastIteratorRow method is:</p>
498
499<pre class="code">
500 void PixelSetLastIteratorRow(PixelIterator *iterator)
501</pre>
502
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]503<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]504
505<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]506<p>the magick iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]507
508 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]509<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
510_8c.html" id="PixelSyncIterator">PixelSyncIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]511<div class="doc-section">
512
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]513<p>PixelSyncIterator() syncs the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]514
515<p>The format of the PixelSyncIterator method is:</p>
516
517<pre class="code">
518 MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
519</pre>
520
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]521<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]522
523<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]524<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]525
526 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]527
528</div>
529
530<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]531 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]532 <span id="linkbar-center">
533 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]534 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]535 </span>
536 <span id="linkbar-east">&nbsp;</span>
537 </div>
538 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]539 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]540 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
541 </div>
542 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]543 <script type="text/javascript">
544 var _gaq = _gaq || [];
545 _gaq.push(['_setAccount', 'UA-17690367-1']);
546 _gaq.push(['_trackPageview']);
547
548 (function() {
549 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
550 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
551 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
552 })();
553 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]554</body>
555</html>