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
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
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
48 <div class="westbar">
\r
51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
53 <div class="sep"></div>
\r
55 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
66 <div class="sep"></div>
\r
68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
71 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
74 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
83 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
86 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
89 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
94 <div class="sep"></div>
\r
96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
99 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
105 <a title="Resources" href="../../www/resources.html">Resources</a>
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
111 <a title="Download" href="../../www/download.html">Download</a>
113 <div class="sep"></div>
\r
115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
117 <div class="sep"></div>
\r
119 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
122 <a title="Site Map: Links"href="../../www/links.html">Links</a>
124 <div class="sep"></div>
\r
126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
128 <div class="sponsbox">
129 <div class="sponsor">
130 <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
132 <div class="sponsor">
133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
135 <div class="sponsor">
136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
138 <div class="sponsor">
139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
141 <div class="sponsor">
142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
144 <div class="sponsor">
145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
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-->
150 <div class="sponsor">
151 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
157 <div class="eastbar">
\r
158 <script type="text/javascript">
\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
166 <script type="text/javascript"
\r
167 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
\r
173 <p class="navigation-index">[<a href="#CloneWandView">CloneWandView</a> • <a href="#DestroyWandView">DestroyWandView</a> • <a href="#DuplexTransferWandViewIterator">DuplexTransferWandViewIterator</a> • <a href="#GetWandViewException">GetWandViewException</a> • <a href="#GetWandViewExtent">GetWandViewExtent</a> • <a href="#GetWandViewIterator">GetWandViewIterator</a> • <a href="#GetWandViewPixels">GetWandViewPixels</a> • <a href="#GetWandViewWand">GetWandViewWand</a> • <a href="#IsWandView">IsWandView</a> • <a href="#NewWandView">NewWandView</a> • <a href="#NewWandViewExtent">NewWandViewExtent</a> • <a href="#SetWandViewDescription">SetWandViewDescription</a> • <a href="#SetWandViewIterator">SetWandViewIterator</a> • <a href="#SetWandViewThreads">SetWandViewThreads</a> • <a href="#TransferWandViewIterator">TransferWandViewIterator</a> • <a href="#UpdateWandViewIterator">UpdateWandViewIterator</a>]</p>
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">
179 <p>CloneWandView() makes a copy of the specified wand view.</p></ol>
181 <p>The format of the CloneWandView method is:</p>
184 WandView *CloneWandView(const WandView *wand_view)
187 <p>A description of each parameter follows:</p></ol>
190 <ol><p>the wand view.</p></ol>
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">
197 <p>DestroyWandView() deallocates memory associated with a wand view.</p></ol>
199 <p>The format of the DestroyWandView method is:</p>
202 WandView *DestroyWandView(WandView *wand_view)
205 <p>A description of each parameter follows:</p></ol>
208 <ol><p>the wand view.</p></ol>
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">
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>
217 <p>The callback signature is:</p>
220 MagickBooleanType DuplexTransferImageViewMethod(const WandView *source,
221 const WandView *duplex,WandView *destination,const ssize_t y,
222 const int thread_id,void *context)
225 <p>Use this pragma if the view is not single threaded:</p>
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>
233 <p>The format of the DuplexTransferWandViewIterator method is:</p>
236 MagickBooleanType DuplexTransferWandViewIterator(WandView *source,
237 WandView *duplex,WandView *destination,
238 DuplexTransferWandViewMethod transfer,void *context)
241 <p>A description of each parameter follows:</p></ol>
244 <ol><p>the source wand view.</p></ol>
247 <ol><p>the duplex wand view.</p></ol>
250 <ol><p>the destination wand view.</p></ol>
253 <ol><p>the transfer callback method.</p></ol>
256 <ol><p>the user defined context.</p></ol>
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">
263 <p>GetWandViewException() returns the severity, reason, and description of any error that occurs when utilizing a wand view.</p></ol>
265 <p>The format of the GetWandViewException method is:</p>
268 char *GetWandViewException(const PixelWand *wand_view,
269 ExceptionType *severity)
272 <p>A description of each parameter follows:</p></ol>
275 <ol><p>the pixel wand_view.</p></ol>
278 <ol><p>the severity of the error is returned here.</p></ol>
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">
285 <p>GetWandViewExtent() returns the wand view extent.</p></ol>
287 <p>The format of the GetWandViewExtent method is:</p>
290 RectangleInfo GetWandViewExtent(const WandView *wand_view)
293 <p>A description of each parameter follows:</p></ol>
296 <ol><p>the wand view.</p></ol>
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">
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>
305 <p>The callback signature is:</p>
308 MagickBooleanType GetImageViewMethod(const WandView *source,
309 const ssize_t y,const int thread_id,void *context)
312 <p>Use this pragma if the view is not single threaded:</p>
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>
320 <p>The format of the GetWandViewIterator method is:</p>
323 MagickBooleanType GetWandViewIterator(WandView *source,
324 GetWandViewMethod get,void *context)
327 <p>A description of each parameter follows:</p></ol>
330 <ol><p>the source wand view.</p></ol>
333 <ol><p>the get callback method.</p></ol>
336 <ol><p>the user defined context.</p></ol>
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">
343 <p>GetWandViewPixels() returns the wand view pixel_wands.</p></ol>
345 <p>The format of the GetWandViewPixels method is:</p>
348 PixelWand *GetWandViewPixels(const WandView *wand_view)
351 <p>A description of each parameter follows:</p></ol>
354 <ol><p>the wand view.</p></ol>
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">
361 <p>GetWandViewWand() returns the magick wand associated with the wand view.</p></ol>
363 <p>The format of the GetWandViewWand method is:</p>
366 MagickWand *GetWandViewWand(const WandView *wand_view)
369 <p>A description of each parameter follows:</p></ol>
372 <ol><p>the wand view.</p></ol>
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">
379 <p>IsWandView() returns MagickTrue if the the parameter is verified as a wand view object.</p></ol>
381 <p>The format of the IsWandView method is:</p>
384 MagickBooleanType IsWandView(const WandView *wand_view)
387 <p>A description of each parameter follows:</p></ol>
390 <ol><p>the wand view.</p></ol>
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">
397 <p>NewWandView() returns a wand view required for all other methods in the Wand View API.</p></ol>
399 <p>The format of the NewWandView method is:</p>
402 WandView *NewWandView(MagickWand *wand)
405 <p>A description of each parameter follows:</p></ol>
408 <ol><p>the wand.</p></ol>
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">
415 <p>NewWandViewExtent() returns a wand view required for all other methods in the Wand View API.</p></ol>
417 <p>The format of the NewWandViewExtent method is:</p>
420 WandView *NewWandViewExtent(MagickWand *wand,const ssize_t x,
421 const ssize_t y,const size_t width,const size_t height)
424 <p>A description of each parameter follows:</p></ol>
427 <ol><p>the magick wand.</p></ol>
429 <h5>x,y,columns,rows</h5>
430 <ol><p>These values define the perimeter of a extent of pixel_wands view.</p></ol>
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">
437 <p>SetWandViewDescription() associates a description with an image view.</p></ol>
439 <p>The format of the SetWandViewDescription method is:</p>
442 void SetWandViewDescription(WandView *image_view,const char *description)
445 <p>A description of each parameter follows:</p></ol>
448 <ol><p>the wand view.</p></ol>
451 <ol><p>the wand view description.</p></ol>
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">
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>
460 <p>The callback signature is:</p>
463 MagickBooleanType SetImageViewMethod(ImageView *destination,
464 const ssize_t y,const int thread_id,void *context)
467 <p>Use this pragma if the view is not single threaded:</p>
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>
475 <p>The format of the SetWandViewIterator method is:</p>
478 MagickBooleanType SetWandViewIterator(WandView *destination,
479 SetWandViewMethod set,void *context)
482 <p>A description of each parameter follows:</p></ol>
485 <ol><p>the wand view.</p></ol>
488 <ol><p>the set callback method.</p></ol>
491 <ol><p>the user defined context.</p></ol>
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">
498 <p>SetWandViewThreads() sets the number of threads in a thread team.</p></ol>
500 <p>The format of the SetWandViewDescription method is:</p>
503 void SetWandViewThreads(WandView *image_view,
504 const size_t number_threads)
507 <p>A description of each parameter follows:</p></ol>
510 <ol><p>the image view.</p></ol>
512 <h5>number_threads</h5>
513 <ol><p>the number of threads in a thread team.</p></ol>
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">
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>
522 <p>The callback signature is:</p>
525 MagickBooleanType TransferImageViewMethod(const WandView *source,
526 WandView *destination,const ssize_t y,const int thread_id,
530 <p>Use this pragma if the view is not single threaded:</p>
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>
538 <p>The format of the TransferWandViewIterator method is:</p>
541 MagickBooleanType TransferWandViewIterator(WandView *source,
542 WandView *destination,TransferWandViewMethod transfer,void *context)
545 <p>A description of each parameter follows:</p></ol>
548 <ol><p>the source wand view.</p></ol>
551 <ol><p>the destination wand view.</p></ol>
554 <ol><p>the transfer callback method.</p></ol>
557 <ol><p>the user defined context.</p></ol>
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">
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>
566 <p>The callback signature is:</p>
569 MagickBooleanType UpdateImageViewMethod(WandView *source,const ssize_t y,
570 const int thread_id,void *context)
573 <p>Use this pragma if the view is not single threaded:</p>
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>
581 <p>The format of the UpdateWandViewIterator method is:</p>
584 MagickBooleanType UpdateWandViewIterator(WandView *source,
585 UpdateWandViewMethod update,void *context)
588 <p>A description of each parameter follows:</p></ol>
591 <ol><p>the source wand view.</p></ol>
594 <ol><p>the update callback method.</p></ol>
597 <ol><p>the user defined context.</p></ol>
604 <span id="linkbar-west"> </span>
\r
605 <span id="linkbar-center">
\r
606 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
607 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
609 <span id="linkbar-east"> </span>
\r
611 <div class="footer">
\r
612 <span id="footer-west">© 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
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
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