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