1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<style type="text/css"><!--
@import url("../../www/magick.css");
//--></style>
<title>ImageMagick: MagickWand, C API for ImageMagick: Pixel Iterator Methods</title>
<meta http-equiv="Content-Language" content="en-US" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="Reply-to" content="magick-users@imagemagick.org" />
<meta name="Generator" content="PHP" />
<meta name="Keywords" content="magickwc, api, for, imagemagick:, pixel, iterator, methods, ImageMagick, PerlMagick, Magick++, Image, Magick" />
<meta name="Description" content="ImageMagick (TM) is a free software suite to create, edit and compose bitmap images. It can read, convert and write images in a large variety of formats. Images can be cropped, colors can be changed, various effects can be applied, images can be rotated and combined, and text, lines, polygons, ellipses and Bézier curves can be added to images and stretched and rotated. ImageMagick is free software: it is delivered with full source code and can be freely used, copied, modified and distributed. Its license is compatible with the GPL. It runs on all major operating systems. Most of the functionality of ImageMagick can be used interactively from the command line; more often, however, the features are used from programs written in the programming languages Perl, C, C++, Python, PHP, Ruby or Java, for which ready-made ImageMagick interfaces (PerlMagick, Magick++, PythonMagick, MagickWand for PHP, RubyMagick, and JMagick) are available. This makes it possible to modify or create images automatically and dynamically. ImageMagick supports many image formats (over 90 major formats) including popular formats like TIFF, JPEG, PNG, PDF, PhotoCD, and GIF." />
<meta name="Rating" content="GENERAL" />
<meta name="Robots" content="ALL" />
<meta name="Generator" content="ImageMagick Studio LLC" />
<meta name="Author" content="ImageMagick Studio LLC" />
<meta name="Revisit-after" content="2 DAYS" />
<meta name="Resource-type" content="document" />
<meta name="Copyright" content="Copyright (c) 1999-2005 ImageMagick Studio LLC" />
<meta name="Distribution" content="Global" />
<link rel="shortcut icon" href="/../images/wand.ico" type="image/x-icon" />
</head>
<body id="www-imagemagick-org">
<table width="100%" id="titlebar" bgcolor="#f5f5f5" cellpadding="0" cellspacing="0" border="0" summary="ImageMagick">
<tbody>
<tr valign="top">
<td align="left"><a href="../../index.html"><img id="titlebar-west" src="../../images/script.png" alt="[ImageMagick]" width="202" height="118" border="0" name="titlebar-west" /></a></td>
<td width="35%"><br /></td>
<td align="left"><a href="http://www.imagemagick.org/" target="1414978827"><img id="titlebar-west" src="../../images/sponsor.jpg" alt="[sponsor]" border="0" vspace="28" name="titlebar-west" /></a></td>
<td width="65%"><br /></td>
<td bgcolor="white" align="right"><a href="../../index.html"><img src="../../images/sprite.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td>
<td bgcolor="white" align="right"><a href="../../index.html"><img id="titlebar-east" src="../../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td>
</tr>
</tbody>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0" summary="">
<tbody>
<tr valign="top" style="height: 100%;">
<td id="menu" width="1%" height="100%">
<p><a href="#main">Skip to page contents</a></p>
<span>[</span>
<a href="../../index.html">About ImageMagick</a>
<a href="../../www/command-line-tools.html">Command-line Tools</a>
<a href="../../www/api.html">Program Interfaces</a>
<span>]</span><br /><span>[</span>
<a href="../../www/install-source.html">Install from Source</a>
<a href="../../www/binary-releases.html">Binary Releases</a>
<a href="../../www/resources.html">Resources</a>
<span>]</span><br /><span>[</span>
<a href="../../www/download.html">Download</a>
<span>]</span><br /><span>[</span>
<a href="../../www/links.html">Links</a>
<span>]</span><br /><br /><span>[</span>
<a href="../../www/sponsors.html">Sponsors</a>
<a href="http://www.georeviews.com" class="sponsor" target="sponsor">Consumer Reviews<br />and Ratings</a><!-- 20050515 -->
<span>]</span>
</td>
<td id="main" valign="top">
<p class="navigation-index">[ <a href="#ClearPixelIterator">ClearPixelIterator</a> | <a href="#DestroyPixelIterator">DestroyPixelIterator</a> | <a href="#IsPixelIterator">IsPixelIterator</a> | <a href="#NewPixelIterator">NewPixelIterator</a> | <a href="#PixelClearIteratorException">PixelClearIteratorException</a> | <a href="#NewPixelRegionIterator">NewPixelRegionIterator</a> | <a href="#PixelGetIteratorException">PixelGetIteratorException</a> | <a href="#PixelGetNextIteratorRow">PixelGetNextIteratorRow</a> | <a href="#PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a> | <a href="#PixelResetIterator">PixelResetIterator</a> | <a href="#PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a> | <a href="#PixelSetIteratorRow">PixelSetIteratorRow</a> | <a href="#PixelSetLastIteratorRow">PixelSetLastIteratorRow</a> | <a href="#PixelSyncIterator">PixelSyncIterator</a> ]</p>
<div style="margin: auto;">
<h2><a name="ClearPixelIterator">ClearPixelIterator</a></h2>
</div>
<p>ClearPixelIterator() clear resources associated with a PixelIterator.</p>
<p>The format of the ClearPixelIterator method is:</p>
<pre class="code">
PixelIterator *ClearPixelIterator(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<h4>iterator</h4>
<p>The pixel iterator.</p>
<div style="margin: auto;">
<h2><a name="DestroyPixelIterator">DestroyPixelIterator</a></h2>
</div>
<p>DestroyPixelIterator() deallocates resources associated with a PixelIterator.</p>
<p>The format of the DestroyPixelIterator method is:</p>
<pre class="code">
PixelIterator *DestroyPixelIterator(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<h4>iterator</h4>
<p>The pixel iterator.</p>
<div style="margin: auto;">
<h2><a name="IsPixelIterator">IsPixelIterator</a></h2>
</div>
<p>IsPixelIterator() returns MagickTrue if the iterator is verified as a pixel iterator.</p>
<p>The format of the IsPixelIterator method is:</p>
<pre class="code">
MagickBooleanType IsPixelIterator(const PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<h4>iterator</h4>
<p>The magick iterator.</p>
<div style="margin: auto;">
<h2><a name="NewPixelIterator">NewPixelIterator</a></h2>
</div>
<p>NewPixelIterator() returns a new pixel iterator.</p>
<p>The format of the NewPixelIterator method is:</p>
<pre class="code">
PixelIterator NewPixelIterator(MagickWand *wand)
</pre>
<p>A description of each parameter follows:</p>
<h4>wand</h4>
<p>The magick wand.</p>
<div style="margin: auto;">
<h2><a name="PixelClearIteratorException">PixelClearIteratorException</a></h2>
</div>
<p>PixelClearIteratorException() clear any exceptions associated with the iterator.</p>
<p>The format of the PixelClearIteratorException method is:</p>
<pre class="code">
MagickBooleanType PixelClearIteratorException(PixelIterator *wand)
</pre>
<p>A description of each parameter follows:</p>
<h4>wand</h4>
<p>The pixel wand.</p>
<div style="margin: auto;">
<h2><a name="NewPixelRegionIterator">NewPixelRegionIterator</a></h2>
</div>
<p>NewPixelRegionIterator() returns a new pixel iterator.</p>
<p>The format of the NewPixelRegionIterator method is:</p>
<pre class="code">
PixelIterator NewPixelRegionIterator(MagickWand *wand,const long x,
const long y,const unsigned long columns,const unsigned long rows,
const MagickBooleanType modify)
</pre>
<p>A description of each parameter follows:</p>
<h4>wand</h4>
<p>The magick wand.</p>
<h4>x,y,columns,rows</h4>
<p>These values define the perimeter of a region of pixels.</p>
<div style="margin: auto;">
<h2><a name="PixelGetIteratorException">PixelGetIteratorException</a></h2>
</div>
<p>PixelGetIteratorException() returns the severity, reason, and description of any error that occurs when using other methods in this API.</p>
<p>The format of the PixelGetIteratorException method is:</p>
<pre class="code">
char *PixelGetIteratorException(const Pixeliterator *iterator,
ExceptionType *severity)
</pre>
<p>A description of each parameter follows:</p>
<h4>iterator</h4>
<p>The pixel iterator.</p>
<h4>severity</h4>
<p>The severity of the error is returned here.</p>
<div style="margin: auto;">
<h2><a name="PixelGetNextIteratorRow">PixelGetNextIteratorRow</a></h2>
</div>
<p>PixelGetNextIteratorRow() returns the next row as an array of pixel wands from the pixel iterator.</p>
<p>The format of the PixelGetNextRow method is:</p>
<pre class="code">
PixelWand **PixelGetNextRow(PixelIterator *iterator,
unsigned long *number_wands)
</pre>
<p>A description of each parameter follows:</p>
<h4>iterator</h4>
<p>The pixel iterator.</p>
<h4>number_wands</h4>
<p>The number of pixel wands.</p>
<div style="margin: auto;">
<h2><a name="PixelGetPreviousIteratorRow">PixelGetPreviousIteratorRow</a></h2>
</div>
<p>PixelGetPreviousIteratorRow() returns the previous row as an array of pixel wands from the pixel iterator.</p>
<p>The format of the PixelGetPreviousRow method is:</p>
<pre class="code">
PixelWand **PixelGetPreviousRow(PixelIterator *iterator,
unsigned long *number_wands)
</pre>
<p>A description of each parameter follows:</p>
<h4>iterator</h4>
<p>The pixel iterator.</p>
<h4>number_wands</h4>
<p>The number of pixel wands.</p>
<div style="margin: auto;">
<h2><a name="PixelResetIterator">PixelResetIterator</a></h2>
</div>
<p>PixelResetIterator() resets the pixel iterator. Use it in conjunction with PixelGetNextPixel() to iterate over all the pixels in a pixel container.</p>
<p>The format of the PixelResetIterator method is:</p>
<pre class="code">
void PixelResetIterator(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<h4>iterator</h4>
<p>The pixel iterator.</p>
<div style="margin: auto;">
<h2><a name="PixelSetFirstIteratorRow">PixelSetFirstIteratorRow</a></h2>
</div>
<p>PixelSetFirstIteratorRow() sets the pixel iterator to the first pixel row.</p>
<p>The format of the PixelSetFirstIteratorRow method is:</p>
<pre class="code">
void PixelSetFirstIteratorRow(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<h4>iterator</h4>
<p>The magick iterator.</p>
<div style="margin: auto;">
<h2><a name="PixelSetIteratorRow">PixelSetIteratorRow</a></h2>
</div>
<p>PixelSetIteratorRow() set the pixel iterator row.</p>
<p>The format of the PixelSetIteratorRow method is:</p>
<pre class="code">
MagickBooleanType PixelSetIteratorRow(PixelIterator *iterator,
const long row)
</pre>
<p>A description of each parameter follows:</p>
<h4>iterator</h4>
<p>The pixel iterator.</p>
<div style="margin: auto;">
<h2><a name="PixelSetLastIteratorRow">PixelSetLastIteratorRow</a></h2>
</div>
<p>PixelSetLastIteratorRow() sets the pixel iterator to the last pixel row.</p>
<p>The format of the PixelSetLastIteratorRow method is:</p>
<pre class="code">
void PixelSetLastIteratorRow(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<h4>iterator</h4>
<p>The magick iterator.</p>
<div style="margin: auto;">
<h2><a name="PixelSyncIterator">PixelSyncIterator</a></h2>
</div>
<p>PixelSyncIterator() syncs the pixel iterator.</p>
<p>The format of the PixelSyncIterator method is:</p>
<pre class="code">
MagickBooleanType PixelSyncIterator(PixelIterator *iterator)
</pre>
<p>A description of each parameter follows:</p>
<h4>iterator</h4>
<p>The pixel iterator.</p>
</td>
<td id="margin" width="1%" height="100%" valign="top" align="right"> </td>
</tr>
</tbody>
</table>
<div id="linkbar">
<a href="http://redux.imagemagick.org/discussion-server" target="49160297">Discourse Server</a> |
<a href="../../www/mailing-list.html">Mailing Lists</a> |
<a href="http://redux.imagemagick.org/gallery" target="1130385549">Image Gallery</a> |
<a href="http://net11.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi" target="1356002753">ImageMagick Studio</a>
</div>
<div>
<span id="footer-west">© 1999-2005 ImageMagick Studio LLC</span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>
|
