]> granicus.if.org Git - imagemagick/blob - www/api/wand-view.html
(no commit message)
[imagemagick] / www / api / wand-view.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
4 <head>\r
5   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
7   <title>ImageMagick: MagickWand, C API for ImageMagick: Wand View Methods</title/>
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"/>
11   <meta name="Application-name" content="ImageMagick"/>
12   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
13   <meta name="Application-url" content="http://www.imagemagick.org"/>
14   <meta name="Generator" content="PHP"/>
15   <meta name="Keywords" content="magickwc, api, for, imagemagick:, wview, methods, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
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"/>
22   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
23   <meta name="Distribution" content="Global"/>
24   <link rel="icon" href="../../images/wand.png"  sizes="32x32"/>
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"/>\r
27   <style type="text/css" media="all">\r
28     @import url("../../www/magick.css");\r
29   </style>\r
30 </head>\r
31 \r
32 <body id="www-imagemagick-org">\r
33 <div class="titlebar">\r
34 <a href="../../index.html">\r
35   <img src="../../images/script.png" alt="[ImageMagick]"\r
36   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
37 <a href="http://www.networkredux.com">\r
38   <img src="../../images/networkredux.png" alt="[sponsor]"\r
39   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
40 <a href="http://www.imagemagick.org/discourse-server/">\r
41   <img src="../../images/logo.jpg" alt=""\r
42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
43 <a href="../../index.html">\r
44   <img src="../../images/sprite.jpg" alt=""\r
45   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
46 </div>\r
47 \r
48 <div class="westbar">\r
49 \r
50 <div class="menu">
51   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
52 </div>
53 <div class="sep"></div>\r
54 <div class="menu">
55   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56 </div>
57 <div class="sub">
58     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59 </div>
60 <div class="sub">
61     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62 </div>
63 <div class="sub">
64     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65 </div>
66 <div class="sep"></div>\r
67 <div class="menu">
68   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
69 </div>
70 <div class="sub">
71     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
72 </div>
73 <div class="sub">
74     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
75 </div>
76 <div class="sub">
77     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
78 </div>
79 <div class="menu">
80   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
81 </div>
82 <div class="sub">
83     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
84 </div>
85 <div class="sub">
86     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
87 </div>
88 <div class="sub">
89     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
90 </div>
91 <div class="sub">
92     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
93 </div>
94 <div class="sep"></div>\r
95 <div  class="menu">
96    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
97 </div>
98 <div class="sub">
99     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
100 </div>
101 <div class="sub">
102     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
103  </div>
104 <div class="menu">
105   <a title="Resources" href="../../www/resources.html">Resources</a>
106 </div>
107 <div class="menu">
108   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109 </div>
110 <div class="menu">
111   <a title="Download" href="../../www/download.html">Download</a>
112 </div>
113 <div class="sep"></div>\r
114 <div class="menu">
115   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
116 </div>
117 <div class="sep"></div>\r
118 <div class="menu">
119   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
120 </div>
121 <div  class="sub">
122     <a title="Site Map: Links"href="../../www/links.html">Links</a>
123 </div>
124 <div class="sep"></div>\r
125 <div  class="menu">
126   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
127
128 <div class="sponsbox">
129 <div  class="sponsor">
130    <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
131 </div>
132 <div  class="sponsor">
133   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
134 </div>
135 <div  class="sponsor">
136   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137 </div>
138 <div  class="sponsor">
139   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140 </div>
141 <div  class="sponsor">
142   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
143 </div>
144 <div  class="sponsor">
145   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
146 </div>
147 <div  class="sponsor">
148   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
149 </div>
150 <div  class="sponsor">
151    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
152 </div>
153 </div>
154 </div>
155 </div>\r
156 \r
157 <div class="eastbar">\r
158   <script type="text/javascript">\r
159   <!--\r
160     google_ad_client = "pub-3129977114552745";\r
161     google_ad_slot = "0574824969";\r
162     google_ad_width = 160;\r
163     google_ad_height = 600;\r
164   //-->\r
165   </script>\r
166   <script type="text/javascript"\r
167     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
168   </script>\r
169 </div>\r
170 \r
171 <div class="main">\r
172 \r
173 <p class="navigation-index">[<a href="#CloneWandView">CloneWandView</a> &bull; <a href="#DestroyWandView">DestroyWandView</a> &bull; <a href="#DuplexTransferWandViewIterator">DuplexTransferWandViewIterator</a> &bull; <a href="#GetWandViewException">GetWandViewException</a> &bull; <a href="#GetWandViewExtent">GetWandViewExtent</a> &bull; <a href="#GetWandViewIterator">GetWandViewIterator</a> &bull; <a href="#GetWandViewPixels">GetWandViewPixels</a> &bull; <a href="#GetWandViewWand">GetWandViewWand</a> &bull; <a href="#IsWandView">IsWandView</a> &bull; <a href="#NewWandView">NewWandView</a> &bull; <a href="#NewWandViewExtent">NewWandViewExtent</a> &bull; <a href="#SetWandViewDescription">SetWandViewDescription</a> &bull; <a href="#SetWandViewIterator">SetWandViewIterator</a> &bull; <a href="#SetWandViewThreads">SetWandViewThreads</a> &bull; <a href="#TransferWandViewIterator">TransferWandViewIterator</a> &bull; <a href="#UpdateWandViewIterator">UpdateWandViewIterator</a>]</p>
174
175 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
176 _8c.html" target="source" name="CloneWandView">CloneWandView</a></h2>
177 <div class="doc-section">
178
179 <p>CloneWandView() makes a copy of the specified wand view.</p></ol>
180
181 <p>The format of the CloneWandView method is:</p>
182
183 <pre class="code">
184   WandView *CloneWandView(const WandView *wand_view)
185 </pre>
186
187 <p>A description of each parameter follows:</p></ol>
188
189 <h5>wand_view</h5>
190 <ol><p>the wand view.</p></ol>
191
192  </div>
193 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
194 _8c.html" target="source" name="DestroyWandView">DestroyWandView</a></h2>
195 <div class="doc-section">
196
197 <p>DestroyWandView() deallocates memory associated with a wand view.</p></ol>
198
199 <p>The format of the DestroyWandView method is:</p>
200
201 <pre class="code">
202   WandView *DestroyWandView(WandView *wand_view)
203 </pre>
204
205 <p>A description of each parameter follows:</p></ol>
206
207 <h5>wand_view</h5>
208 <ol><p>the wand view.</p></ol>
209
210  </div>
211 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
212 _8c.html" target="source" name="DuplexTransferWandViewIterator">DuplexTransferWandViewIterator</a></h2>
213 <div class="doc-section">
214
215 <p>DuplexTransferWandViewIterator() iterates over three wand views in parallel and calls your transfer method for each scanline of the view.  The source and duplex pixel extent is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension.  However, the destination wand view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.</p></ol>
216
217 <p>The callback signature is:</p>
218
219 <pre class="text">
220   MagickBooleanType DuplexTransferImageViewMethod(const WandView *source,
221     const WandView *duplex,WandView *destination,const ssize_t y,
222     const int thread_id,void *context)
223 </pre>
224
225 <p>Use this pragma if the view is not single threaded:</p>
226
227 <pre class="text">
228       #pragma omp critical
229 </pre>
230
231 <p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p></ol>
232
233 <p>The format of the DuplexTransferWandViewIterator method is:</p>
234
235 <pre class="code">
236   MagickBooleanType DuplexTransferWandViewIterator(WandView *source,
237     WandView *duplex,WandView *destination,
238     DuplexTransferWandViewMethod transfer,void *context)
239 </pre>
240
241 <p>A description of each parameter follows:</p></ol>
242
243 <h5>source</h5>
244 <ol><p>the source wand view.</p></ol>
245
246 <h5>duplex</h5>
247 <ol><p>the duplex wand view.</p></ol>
248
249 <h5>destination</h5>
250 <ol><p>the destination wand view.</p></ol>
251
252 <h5>transfer</h5>
253 <ol><p>the transfer callback method.</p></ol>
254
255 <h5>context</h5>
256 <ol><p>the user defined context.</p></ol>
257
258  </div>
259 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
260 _8c.html" target="source" name="GetWandViewException">GetWandViewException</a></h2>
261 <div class="doc-section">
262
263 <p>GetWandViewException() returns the severity, reason, and description of any error that occurs when utilizing a wand view.</p></ol>
264
265 <p>The format of the GetWandViewException method is:</p>
266
267 <pre class="code">
268   char *GetWandViewException(const PixelWand *wand_view,
269     ExceptionType *severity)
270 </pre>
271
272 <p>A description of each parameter follows:</p></ol>
273
274 <h5>wand_view</h5>
275 <ol><p>the pixel wand_view.</p></ol>
276
277 <h5>severity</h5>
278 <ol><p>the severity of the error is returned here.</p></ol>
279
280  </div>
281 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
282 _8c.html" target="source" name="GetWandViewExtent">GetWandViewExtent</a></h2>
283 <div class="doc-section">
284
285 <p>GetWandViewExtent() returns the wand view extent.</p></ol>
286
287 <p>The format of the GetWandViewExtent method is:</p>
288
289 <pre class="code">
290   RectangleInfo GetWandViewExtent(const WandView *wand_view)
291 </pre>
292
293 <p>A description of each parameter follows:</p></ol>
294
295 <h5>wand_view</h5>
296 <ol><p>the wand view.</p></ol>
297
298  </div>
299 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
300 _8c.html" target="source" name="GetWandViewIterator">GetWandViewIterator</a></h2>
301 <div class="doc-section">
302
303 <p>GetWandViewIterator() iterates over the wand view in parallel and calls your get method for each scanline of the view.  The pixel extent is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension.  Any updates to the pixels in your callback are ignored.</p></ol>
304
305 <p>The callback signature is:</p>
306
307 <pre class="text">
308   MagickBooleanType GetImageViewMethod(const WandView *source,
309     const ssize_t y,const int thread_id,void *context)
310 </pre>
311
312 <p>Use this pragma if the view is not single threaded:</p>
313
314 <pre class="text">
315       #pragma omp critical
316 </pre>
317
318 <p>to define a section of code in your callback get method that must be executed by a single thread at a time.</p></ol>
319
320 <p>The format of the GetWandViewIterator method is:</p>
321
322 <pre class="code">
323   MagickBooleanType GetWandViewIterator(WandView *source,
324     GetWandViewMethod get,void *context)
325 </pre>
326
327 <p>A description of each parameter follows:</p></ol>
328
329 <h5>source</h5>
330 <ol><p>the source wand view.</p></ol>
331
332 <h5>get</h5>
333 <ol><p>the get callback method.</p></ol>
334
335 <h5>context</h5>
336 <ol><p>the user defined context.</p></ol>
337
338  </div>
339 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
340 _8c.html" target="source" name="GetWandViewPixels">GetWandViewPixels</a></h2>
341 <div class="doc-section">
342
343 <p>GetWandViewPixels() returns the wand view pixel_wands.</p></ol>
344
345 <p>The format of the GetWandViewPixels method is:</p>
346
347 <pre class="code">
348   PixelWand *GetWandViewPixels(const WandView *wand_view)
349 </pre>
350
351 <p>A description of each parameter follows:</p></ol>
352
353 <h5>wand_view</h5>
354 <ol><p>the wand view.</p></ol>
355
356  </div>
357 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
358 _8c.html" target="source" name="GetWandViewWand">GetWandViewWand</a></h2>
359 <div class="doc-section">
360
361 <p>GetWandViewWand() returns the magick wand associated with the wand view.</p></ol>
362
363 <p>The format of the GetWandViewWand method is:</p>
364
365 <pre class="code">
366   MagickWand *GetWandViewWand(const WandView *wand_view)
367 </pre>
368
369 <p>A description of each parameter follows:</p></ol>
370
371 <h5>wand_view</h5>
372 <ol><p>the wand view.</p></ol>
373
374  </div>
375 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
376 _8c.html" target="source" name="IsWandView">IsWandView</a></h2>
377 <div class="doc-section">
378
379 <p>IsWandView() returns MagickTrue if the the parameter is verified as a wand view object.</p></ol>
380
381 <p>The format of the IsWandView method is:</p>
382
383 <pre class="code">
384   MagickBooleanType IsWandView(const WandView *wand_view)
385 </pre>
386
387 <p>A description of each parameter follows:</p></ol>
388
389 <h5>wand_view</h5>
390 <ol><p>the wand view.</p></ol>
391
392  </div>
393 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
394 _8c.html" target="source" name="NewWandView">NewWandView</a></h2>
395 <div class="doc-section">
396
397 <p>NewWandView() returns a wand view required for all other methods in the Wand View API.</p></ol>
398
399 <p>The format of the NewWandView method is:</p>
400
401 <pre class="code">
402   WandView *NewWandView(MagickWand *wand)
403 </pre>
404
405 <p>A description of each parameter follows:</p></ol>
406
407 <h5>wand</h5>
408 <ol><p>the wand.</p></ol>
409
410  </div>
411 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
412 _8c.html" target="source" name="NewWandViewExtent">NewWandViewExtent</a></h2>
413 <div class="doc-section">
414
415 <p>NewWandViewExtent() returns a wand view required for all other methods in the Wand View API.</p></ol>
416
417 <p>The format of the NewWandViewExtent method is:</p>
418
419 <pre class="code">
420   WandView *NewWandViewExtent(MagickWand *wand,const ssize_t x,
421     const ssize_t y,const size_t width,const size_t height)
422 </pre>
423
424 <p>A description of each parameter follows:</p></ol>
425
426 <h5>wand</h5>
427 <ol><p>the magick wand.</p></ol>
428
429 <h5>x,y,columns,rows</h5>
430 <ol><p>These values define the perimeter of a extent of pixel_wands view.</p></ol>
431
432  </div>
433 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
434 _8c.html" target="source" name="SetWandViewDescription">SetWandViewDescription</a></h2>
435 <div class="doc-section">
436
437 <p>SetWandViewDescription() associates a description with an image view.</p></ol>
438
439 <p>The format of the SetWandViewDescription method is:</p>
440
441 <pre class="code">
442   void SetWandViewDescription(WandView *image_view,const char *description)
443 </pre>
444
445 <p>A description of each parameter follows:</p></ol>
446
447 <h5>wand_view</h5>
448 <ol><p>the wand view.</p></ol>
449
450 <h5>description</h5>
451 <ol><p>the wand view description.</p></ol>
452
453  </div>
454 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
455 _8c.html" target="source" name="SetWandViewIterator">SetWandViewIterator</a></h2>
456 <div class="doc-section">
457
458 <p>SetWandViewIterator() iterates over the wand view in parallel and calls your set method for each scanline of the view.  The pixel extent is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension.  The pixels are initiallly undefined and any settings you make in the callback method are automagically synced back to your image.</p></ol>
459
460 <p>The callback signature is:</p>
461
462 <pre class="text">
463   MagickBooleanType SetImageViewMethod(ImageView *destination,
464     const ssize_t y,const int thread_id,void *context)
465 </pre>
466
467 <p>Use this pragma if the view is not single threaded:</p>
468
469 <pre class="text">
470       #pragma omp critical
471 </pre>
472
473 <p>to define a section of code in your callback set method that must be executed by a single thread at a time.</p></ol>
474
475 <p>The format of the SetWandViewIterator method is:</p>
476
477 <pre class="code">
478   MagickBooleanType SetWandViewIterator(WandView *destination,
479     SetWandViewMethod set,void *context)
480 </pre>
481
482 <p>A description of each parameter follows:</p></ol>
483
484 <h5>destination</h5>
485 <ol><p>the wand view.</p></ol>
486
487 <h5>set</h5>
488 <ol><p>the set callback method.</p></ol>
489
490 <h5>context</h5>
491 <ol><p>the user defined context.</p></ol>
492
493  </div>
494 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
495 _8c.html" target="source" name="SetWandViewThreads">SetWandViewThreads</a></h2>
496 <div class="doc-section">
497
498 <p>SetWandViewThreads() sets the number of threads in a thread team.</p></ol>
499
500 <p>The format of the SetWandViewDescription method is:</p>
501
502 <pre class="code">
503   void SetWandViewThreads(WandView *image_view,
504     const size_t number_threads)
505 </pre>
506
507 <p>A description of each parameter follows:</p></ol>
508
509 <h5>image_view</h5>
510 <ol><p>the image view.</p></ol>
511
512 <h5>number_threads</h5>
513 <ol><p>the number of threads in a thread team.</p></ol>
514
515  </div>
516 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
517 _8c.html" target="source" name="TransferWandViewIterator">TransferWandViewIterator</a></h2>
518 <div class="doc-section">
519
520 <p>TransferWandViewIterator() iterates over two wand views in parallel and calls your transfer method for each scanline of the view.  The source pixel extent is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. However, the destination wand view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.</p></ol>
521
522 <p>The callback signature is:</p>
523
524 <pre class="text">
525   MagickBooleanType TransferImageViewMethod(const WandView *source,
526     WandView *destination,const ssize_t y,const int thread_id,
527     void *context)
528 </pre>
529
530 <p>Use this pragma if the view is not single threaded:</p>
531
532 <pre class="text">
533       #pragma omp critical
534 </pre>
535
536 <p>to define a section of code in your callback transfer method that must be executed by a single thread at a time.</p></ol>
537
538 <p>The format of the TransferWandViewIterator method is:</p>
539
540 <pre class="code">
541   MagickBooleanType TransferWandViewIterator(WandView *source,
542     WandView *destination,TransferWandViewMethod transfer,void *context)
543 </pre>
544
545 <p>A description of each parameter follows:</p></ol>
546
547 <h5>source</h5>
548 <ol><p>the source wand view.</p></ol>
549
550 <h5>destination</h5>
551 <ol><p>the destination wand view.</p></ol>
552
553 <h5>transfer</h5>
554 <ol><p>the transfer callback method.</p></ol>
555
556 <h5>context</h5>
557 <ol><p>the user defined context.</p></ol>
558
559  </div>
560 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
561 _8c.html" target="source" name="UpdateWandViewIterator">UpdateWandViewIterator</a></h2>
562 <div class="doc-section">
563
564 <p>UpdateWandViewIterator() iterates over the wand view in parallel and calls your update method for each scanline of the view.  The pixel extent is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.  Updates to pixels in your callback are automagically synced back to the image.</p></ol>
565
566 <p>The callback signature is:</p>
567
568 <pre class="text">
569   MagickBooleanType UpdateImageViewMethod(WandView *source,const ssize_t y,
570     const int thread_id,void *context)
571 </pre>
572
573 <p>Use this pragma if the view is not single threaded:</p>
574
575 <pre class="text">
576       #pragma omp critical
577 </pre>
578
579 <p>to define a section of code in your callback update method that must be executed by a single thread at a time.</p></ol>
580
581 <p>The format of the UpdateWandViewIterator method is:</p>
582
583 <pre class="code">
584   MagickBooleanType UpdateWandViewIterator(WandView *source,
585     UpdateWandViewMethod update,void *context)
586 </pre>
587
588 <p>A description of each parameter follows:</p></ol>
589
590 <h5>source</h5>
591 <ol><p>the source wand view.</p></ol>
592
593 <h5>update</h5>
594 <ol><p>the update callback method.</p></ol>
595
596 <h5>context</h5>
597 <ol><p>the user defined context.</p></ol>
598
599  </div>
600 \r
601 </div>\r
602 \r
603 <div id="linkbar">\r
604     <span id="linkbar-west">&nbsp;</span>\r
605     <span id="linkbar-center">\r
606       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
607       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
608     </span>\r
609     <span id="linkbar-east">&nbsp;</span>\r
610   </div>\r
611   <div class="footer">\r
612     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
613     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
614   </div>\r
615   <div style="clear: both; margin: 0; width: 100%; "></div>\r
616   <script type="text/javascript">\r
617     var _gaq = _gaq || [];\r
618     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
619     _gaq.push(['_trackPageview']);\r
620 \r
621     (function() {\r
622       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
623       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
624       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
625     })();\r
626   </script>\r
627 </body>\r
628 </html>\r