Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 178edafa2ddbc40465115383b13685f7bc913b1f / . / www / api / pixel-iterator.html
blob: 3b8cfb759e0052f1abd9c8a1906fc585ef2c5b74 [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=""
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame^]56 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]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">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame^]143<div class="sponsor">
144 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
145</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]146<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]147 <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]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">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame^]156 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
157</div>
158<div class="sponsor">
159 <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]160</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161</div>
162</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]163</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]164
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]165<div class="eastbar">
166 <script type="text/javascript">
167 <!--
168 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]169 google_ad_slot = "0574824969";
170 google_ad_width = 160;
171 google_ad_height = 600;
172 //-->
173 </script>
174 <script type="text/javascript"
175 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
176 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]177</div>
178
179<div class="main">
180
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]181<h1>Module pixel-iterator
182 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]183<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>
184
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]185<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
186_8c.html" id="ClearPixelIterator">ClearPixelIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]187<div class="doc-section">
188
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]189<p>ClearPixelIterator() clear resources associated with a PixelIterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]190
191<p>The format of the ClearPixelIterator method is:</p>
192
193<pre class="code">
194 PixelIterator *ClearPixelIterator(PixelIterator *iterator)
195</pre>
196
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]197<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]198
199<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]200<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]201
202 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]203<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
204_8c.html" id="ClonePixelIterator">ClonePixelIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]205<div class="doc-section">
206
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]207<p>ClonePixelIterator() makes an exact copy of the specified iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]208
209<p>The format of the ClonePixelIterator method is:</p>
210
211<pre class="code">
212 PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
213</pre>
214
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]215<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]216
217<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]218<p>the magick iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]219
220 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]221<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
222_8c.html" id="DestroyPixelIterator">DestroyPixelIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]223<div class="doc-section">
224
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]225<p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]226
227<p>The format of the DestroyPixelIterator method is:</p>
228
229<pre class="code">
230 PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
231</pre>
232
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]233<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]234
235<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]236<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]237
238 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]239<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
240_8c.html" id="IsPixelIterator">IsPixelIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]241<div class="doc-section">
242
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]243<p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]244
245<p>The format of the IsPixelIterator method is:</p>
246
247<pre class="code">
248 MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
249</pre>
250
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]251<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]252
253<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]254<p>the magick iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]255
256 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]257<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
258_8c.html" id="NewPixelIterator">NewPixelIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]259<div class="doc-section">
260
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]261<p>NewPixelIterator() returns a new pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]262
263<p>The format of the NewPixelIterator method is:</p>
264
265<pre class="code">
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]266 PixelIterator *NewPixelIterator(MagickWand *wand)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]267</pre>
268
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]269<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]270
271<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]272<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]273
274 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]275<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
276_8c.html" id="PixelClearIteratorException">PixelClearIteratorException</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]277<div class="doc-section">
278
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]279<p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]280
281<p>The format of the PixelClearIteratorException method is:</p>
282
283<pre class="code">
284 MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
285</pre>
286
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]287<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]288
289<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]290<p>the pixel wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]291
292 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]293<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
294_8c.html" id="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]295<div class="doc-section">
296
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]297<p>NewPixelRegionIterator() returns a new pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]298
299<p>The format of the NewPixelRegionIterator method is:</p>
300
301<pre class="code">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]302 PixelIterator NewPixelRegionIterator(MagickWand *wand,const ssize_t x,
303 const ssize_t y,const size_t width,const size_t height)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]304</pre>
305
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]306<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]307
308<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]309<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]310
311<h5>x,y,columns,rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]312<p>These values define the perimeter of a region of pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]313
314 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]315<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
316_8c.html" id="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]317<div class="doc-section">
318
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]319<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]320
321<p>The format of the PixelGetCurrentIteratorRow method is:</p>
322
323<pre class="code">
324 PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]325 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]326</pre>
327
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]328<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]329
330<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]331<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]332
333<h5>number_wands</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]334<p>the number of pixel wands.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]335
336 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]337<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
338_8c.html" id="PixelGetIteratorException">PixelGetIteratorException</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]339<div class="doc-section">
340
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]341<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]342
343<p>The format of the PixelGetIteratorException method is:</p>
344
345<pre class="code">
346 char *PixelGetIteratorException(const Pixeliterator *iterator,
347 ExceptionType *severity)
348</pre>
349
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]350<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]351
352<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]353<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]354
355<h5>severity</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]356<p>the severity of the error is returned here.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]357
358 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]359<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
360_8c.html" id="PixelGetIteratorExceptionType">PixelGetIteratorExceptionType</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]361<div class="doc-section">
362
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]363<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]364
365<p>The format of the PixelGetIteratorExceptionType method is:</p>
366
367<pre class="code">
368 ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
369</pre>
370
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]371<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]372
373<h5>wand</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]374<p>the magick wand.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]375
376 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]377<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
378_8c.html" id="PixelGetIteratorRow">PixelGetIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]379<div class="doc-section">
380
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]381<p>PixelGetIteratorRow() returns the current pixel iterator row.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]382
383<p>The format of the PixelGetIteratorRow method is:</p>
384
385<pre class="code">
386 MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
387</pre>
388
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]389<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]390
391<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]392<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]393
394 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]395<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
396_8c.html" id="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]397<div class="doc-section">
398
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]399<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]400
401<p>The format of the PixelGetNextIteratorRow method is:</p>
402
403<pre class="code">
404 PixelWand **PixelGetNextIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]405 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]406</pre>
407
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]408<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]409
410<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]411<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]412
413<h5>number_wands</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]414<p>the number of pixel wands.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]415
416 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]417<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
418_8c.html" id="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]419<div class="doc-section">
420
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]421<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]422
423<p>The format of the PixelGetPreviousIteratorRow method is:</p>
424
425<pre class="code">
426 PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]427 size_t *number_wands)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]428</pre>
429
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]430<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]431
432<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]433<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]434
435<h5>number_wands</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]436<p>the number of pixel wands.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]437
438 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]439<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
440_8c.html" id="PixelResetIterator">PixelResetIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]441<div class="doc-section">
442
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]443<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]444
445<p>The format of the PixelResetIterator method is:</p>
446
447<pre class="code">
448 void PixelResetIterator(PixelIterator *iterator)
449</pre>
450
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]451<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]452
453<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]454<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]455
456 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]457<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
458_8c.html" id="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]459<div class="doc-section">
460
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]461<p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]462
463<p>The format of the PixelSetFirstIteratorRow method is:</p>
464
465<pre class="code">
466 void PixelSetFirstIteratorRow(PixelIterator *iterator)
467</pre>
468
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]469<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]470
471<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]472<p>the magick iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]473
474 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]475<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
476_8c.html" id="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]477<div class="doc-section">
478
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]479<p>PixelSetIteratorRow() set the pixel iterator row.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]480
481<p>The format of the PixelSetIteratorRow method is:</p>
482
483<pre class="code">
484 MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]485 const ssize_t row)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]486</pre>
487
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]488<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]489
490<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]491<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]492
493 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]494<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
495_8c.html" id="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]496<div class="doc-section">
497
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]498<p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]499
500<p>The format of the PixelSetLastIteratorRow method is:</p>
501
502<pre class="code">
503 void PixelSetLastIteratorRow(PixelIterator *iterator)
504</pre>
505
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]506<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]507
508<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]509<p>the magick iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]510
511 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]512<h2><a href="http://www.wizards-toolkit.org/api/MagickWand/pixel-iterator
513_8c.html" id="PixelSyncIterator">PixelSyncIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]514<div class="doc-section">
515
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]516<p>PixelSyncIterator() syncs the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]517
518<p>The format of the PixelSyncIterator method is:</p>
519
520<pre class="code">
521 MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
522</pre>
523
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]524<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]525
526<h5>iterator</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]527<p>the pixel iterator.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]528
529 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]530
531</div>
532
533<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]534 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]535 <span id="linkbar-center">
536 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]537 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]538 </span>
539 <span id="linkbar-east">&nbsp;</span>
540 </div>
541 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]542 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]543 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
544 </div>
545 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]546 <script type="text/javascript">
547 var _gaq = _gaq || [];
548 _gaq.push(['_setAccount', 'UA-17690367-1']);
549 _gaq.push(['_trackPageview']);
550
551 (function() {
552 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
553 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
554 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
555 })();
556 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]557</body>
558</html>