Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / a4dfb12591af53bd0f5674632a12372e9035ceaf / . / www / api / pixel-iterator.html
blob: a670b75fddff0f156d805306afd7070e50c48919 [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"/>
cristye6e84152011-06-06 14:16:49 +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 automagically."/>
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"/>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]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, Image, Processing, Automagically"/>
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"/>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]30 <link rel="canonical" href="http://www.imagemagick.org" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]31 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]32 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]34 <style type="text/css" media="all">
35 @import url("../../www/magick.css");
36 </style>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]37 <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]38 <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]39 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]40 <script type="text/javascript">
41 $(document).ready(function() {
42 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
43 'transitionIn' : 'elastic',
44 'transitionOut' : 'elastic',
45 'overlayShow' : false,
46 'opacity' : true
47 });
48 });
49 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50</head>
51
52<body id="www-imagemagick-org">
53<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]54<div style="margin: 17px auto; float: left;">
55 <script type="text/javascript">
56 <!--
57 google_ad_client = "pub-3129977114552745";
58 google_ad_slot = "5439289906";
59 google_ad_width = 728;
60 google_ad_height = 90;
61 //-->
62 </script>
63 <script type="text/javascript"
64 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
65 </script>
66</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]67<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]68 <img src="../../images/logo.jpg"
69 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]70 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]71<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]72 <img src="../../images/sprite.jpg"
73 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]74 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
75</div>
76
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]77<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]78
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]83 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
84</div>
85<div class="sub">
86 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
90</div>
91<div class="sub">
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]92 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]93</div>
94<div class="sub">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]95 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
96</div>
97<div class="sep"></div>
98<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</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="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</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="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
113<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]114 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115</div>
116<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]117 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118</div>
119<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]120 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121</div>
122<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]123 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]125<div class="sep"></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="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128</div>
129<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]131</div>
132<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134 </div>
135<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]138<div class="menu">
139 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
140</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="Download" href="../../www/download.html">Download</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">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]146 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]148<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]149<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]150 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]151</div>
152<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]153 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]154</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]155<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]156<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]157 <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]158
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]159<a href="http://www.networkredux.com">
160 <img src="../../images/networkredux.png" alt="[sponsor]"
161 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]162<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]163<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]164 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
165</div>
166<div class="sponsor">
cristy84134182011-06-15 22:59:00 +0000[diff] [blame]167 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
168</div>
169<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]170 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
171</div>
172<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]173 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
174</div>
175<div class="sponsor">
176 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
177</div>
178<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]179 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]180</div>
181<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]182 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000[diff] [blame]183</div>
184<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000[diff] [blame]185 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]186</div>
187<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]188 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]189</div>
190<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]191 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]192</div>
193<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]194 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]195</div>
196<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]197 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]198</div>
199<div class="sponsor">
cristya4dfb122011-07-07 19:01:57 +0000[diff] [blame^]200 <a rel="follow" title="Sponsor: Autoteile Online Shop" href="http://www.autoteile-carparts.de">Autoteile Online Shop</a><!-- 2011080100030 autoteile-Carparts-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]201</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]202</div>
203</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]204</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]205
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]206<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]207<div style="margin: 9pt 9pt 9pt 9pt;">
208 <div class="g-plusone" data-size="standard" data-count="false"></div>
209</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]210</div>
211
212<div class="main">
213
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]214<h1>Module pixel-iterator Methods</h1>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]215<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]216
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]217<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]218<div class="doc-section">
219
220<p>ClearPixelIterator() clear resources associated with a PixelIterator.</p>
221
222<p>The format of the ClearPixelIterator method is:</p>
223
224<pre class="code">
225 PixelIterator *ClearPixelIterator(PixelIterator *iterator)
226</pre>
227
228<p>A description of each parameter follows:</p>
229
230<h5>iterator</h5>
231<p>the pixel iterator.</p>
232
233 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]234<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]235<div class="doc-section">
236
237<p>ClonePixelIterator() makes an exact copy of the specified iterator.</p>
238
239<p>The format of the ClonePixelIterator method is:</p>
240
241<pre class="code">
242 PixelIterator *ClonePixelIterator(const PixelIterator *iterator)
243</pre>
244
245<p>A description of each parameter follows:</p>
246
247<h5>iterator</h5>
248<p>the magick iterator.</p>
249
250 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]251<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]252<div class="doc-section">
253
254<p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p>
255
256<p>The format of the DestroyPixelIterator method is:</p>
257
258<pre class="code">
259 PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
260</pre>
261
262<p>A description of each parameter follows:</p>
263
264<h5>iterator</h5>
265<p>the pixel iterator.</p>
266
267 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]268<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]269<div class="doc-section">
270
271<p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p>
272
273<p>The format of the IsPixelIterator method is:</p>
274
275<pre class="code">
276 MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
277</pre>
278
279<p>A description of each parameter follows:</p>
280
281<h5>iterator</h5>
282<p>the magick iterator.</p>
283
284 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]285<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]286<div class="doc-section">
287
288<p>NewPixelIterator() returns a new pixel iterator.</p>
289
290<p>The format of the NewPixelIterator method is:</p>
291
292<pre class="code">
293 PixelIterator *NewPixelIterator(MagickWand *wand)
294</pre>
295
296<p>A description of each parameter follows:</p>
297
298<h5>wand</h5>
299<p>the magick wand.</p>
300
301 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]302<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]303<div class="doc-section">
304
305<p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p>
306
307<p>The format of the PixelClearIteratorException method is:</p>
308
309<pre class="code">
310 MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
311</pre>
312
313<p>A description of each parameter follows:</p>
314
315<h5>wand</h5>
316<p>the pixel wand.</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="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]320<div class="doc-section">
321
322<p>NewPixelRegionIterator() returns a new pixel iterator.</p>
323
324<p>The format of the NewPixelRegionIterator method is:</p>
325
326<pre class="code">
327 PixelIterator NewPixelRegionIterator(MagickWand *wand,const ssize_t x,
328 const ssize_t y,const size_t width,const size_t height)
329</pre>
330
331<p>A description of each parameter follows:</p>
332
333<h5>wand</h5>
334<p>the magick wand.</p>
335
336<h5>x,y,columns,rows</h5>
337<p>These values define the perimeter of a region of pixels.</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="PixelGetCurrentIteratorRow">PixelGetCurrentIteratorRow</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]341<div class="doc-section">
342
343<p>PixelGetCurrentIteratorRow() returns the current row as an array of pixel wands from the pixel iterator.</p>
344
345<p>The format of the PixelGetCurrentIteratorRow method is:</p>
346
347<pre class="code">
348 PixelWand **PixelGetCurrentIteratorRow(PixelIterator *iterator,
349 size_t *number_wands)
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>number_wands</h5>
358<p>the number of pixel wands.</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="PixelGetIteratorException">PixelGetIteratorException</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]362<div class="doc-section">
363
364<p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
365
366<p>The format of the PixelGetIteratorException method is:</p>
367
368<pre class="code">
369 char *PixelGetIteratorException(const Pixeliterator *iterator,
370 ExceptionType *severity)
371</pre>
372
373<p>A description of each parameter follows:</p>
374
375<h5>iterator</h5>
376<p>the pixel iterator.</p>
377
378<h5>severity</h5>
379<p>the severity of the error is returned here.</p>
380
381 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]382<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]383<div class="doc-section">
384
385<p>PixelGetIteratorExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.</p>
386
387<p>The format of the PixelGetIteratorExceptionType method is:</p>
388
389<pre class="code">
390 ExceptionType PixelGetIteratorExceptionType(const PixelWand *wand)
391</pre>
392
393<p>A description of each parameter follows:</p>
394
395<h5>wand</h5>
396<p>the magick wand.</p>
397
398 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]399<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]400<div class="doc-section">
401
402<p>PixelGetIteratorRow() returns the current pixel iterator row.</p>
403
404<p>The format of the PixelGetIteratorRow method is:</p>
405
406<pre class="code">
407 MagickBooleanType PixelGetIteratorRow(PixelIterator *iterator)
408</pre>
409
410<p>A description of each parameter follows:</p>
411
412<h5>iterator</h5>
413<p>the pixel iterator.</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="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]417<div class="doc-section">
418
419<p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p>
420
421<p>The format of the PixelGetNextIteratorRow method is:</p>
422
423<pre class="code">
424 PixelWand **PixelGetNextIteratorRow(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="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]438<div class="doc-section">
439
440<p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p>
441
442<p>The format of the PixelGetPreviousIteratorRow method is:</p>
443
444<pre class="code">
445 PixelWand **PixelGetPreviousIteratorRow(PixelIterator *iterator,
446 size_t *number_wands)
447</pre>
448
449<p>A description of each parameter follows:</p>
450
451<h5>iterator</h5>
452<p>the pixel iterator.</p>
453
454<h5>number_wands</h5>
455<p>the number of pixel wands.</p>
456
457 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]458<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]459<div class="doc-section">
460
461<p>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextIteratorRow() to iterate over all the pixels in a pixel container.</p>
462
463<p>The format of the PixelResetIterator method is:</p>
464
465<pre class="code">
466 void PixelResetIterator(PixelIterator *iterator)
467</pre>
468
469<p>A description of each parameter follows:</p>
470
471<h5>iterator</h5>
472<p>the pixel iterator.</p>
473
474 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]475<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]476<div class="doc-section">
477
478<p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p>
479
480<p>The format of the PixelSetFirstIteratorRow method is:</p>
481
482<pre class="code">
483 void PixelSetFirstIteratorRow(PixelIterator *iterator)
484</pre>
485
486<p>A description of each parameter follows:</p>
487
488<h5>iterator</h5>
489<p>the magick iterator.</p>
490
491 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]492<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]493<div class="doc-section">
494
495<p>PixelSetIteratorRow() set the pixel iterator row.</p>
496
497<p>The format of the PixelSetIteratorRow method is:</p>
498
499<pre class="code">
500 MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
501 const ssize_t row)
502</pre>
503
504<p>A description of each parameter follows:</p>
505
506<h5>iterator</h5>
507<p>the pixel iterator.</p>
508
509 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]510<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]511<div class="doc-section">
512
513<p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p>
514
515<p>The format of the PixelSetLastIteratorRow method is:</p>
516
517<pre class="code">
518 void PixelSetLastIteratorRow(PixelIterator *iterator)
519</pre>
520
521<p>A description of each parameter follows:</p>
522
523<h5>iterator</h5>
524<p>the magick iterator.</p>
525
526 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]527<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]528<div class="doc-section">
529
530<p>PixelSyncIterator() syncs the pixel iterator.</p>
531
532<p>The format of the PixelSyncIterator method is:</p>
533
534<pre class="code">
535 MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
536</pre>
537
538<p>A description of each parameter follows:</p>
539
540<h5>iterator</h5>
541<p>the pixel iterator.</p>
542
543 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]544
545</div>
546
547<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]548 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]549 <span id="linkbar-center">
550 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]551 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]552 </span>
553 <span id="linkbar-east">&nbsp;</span>
554 </div>
555 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]556 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]557 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
558 </div>
559 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]560 <script type="text/javascript">
561 var _gaq = _gaq || [];
562 _gaq.push(['_setAccount', 'UA-17690367-1']);
563 _gaq.push(['_trackPageview']);
564
565 (function() {
566 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
567 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
568 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
569 })();
570 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]571</body>
572</html>