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