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: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
135 <div class="sponsor">
136 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
138 <div class="sponsor">
139 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
141 <div class="sponsor">
142 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
144 <div class="sponsor">
145 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
147 <div class="sponsor">
148 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
154 <div class="eastbar">
\r
155 <script type="text/javascript">
\r
157 google_ad_client = "pub-3129977114552745";
\r
158 google_ad_slot = "0574824969";
\r
159 google_ad_width = 160;
\r
160 google_ad_height = 600;
\r
163 <script type="text/javascript"
\r
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
\r
170 <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="#TransferWandViewIterator">TransferWandViewIterator</a> • <a href="#UpdateWandViewIterator">UpdateWandViewIterator</a>]</p>
172 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
173 _8c.html" target="source" name="CloneWandView">CloneWandView</a></h2>
174 <div class="doc-section">
176 <p>CloneWandView() makes a copy of the specified wand view.</p></ol>
178 <p>The format of the CloneWandView method is:</p>
181 WandView *CloneWandView(const WandView *wand_view)
184 <p>A description of each parameter follows:</p></ol>
187 <ol><p>the wand view.</p></ol>
190 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
191 _8c.html" target="source" name="DestroyWandView">DestroyWandView</a></h2>
192 <div class="doc-section">
194 <p>DestroyWandView() deallocates memory associated with a wand view.</p></ol>
196 <p>The format of the DestroyWandView method is:</p>
199 WandView *DestroyWandView(WandView *wand_view)
202 <p>A description of each parameter follows:</p></ol>
205 <ol><p>the wand view.</p></ol>
208 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
209 _8c.html" target="source" name="DuplexTransferWandViewIterator">DuplexTransferWandViewIterator</a></h2>
210 <div class="doc-section">
212 <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>
214 <p>The callback signature is:</p>
217 MagickBooleanType DuplexTransferImageViewMethod(const WandView *source,
218 const WandView *duplex,WandView *destination,const ssize_t y,
219 const int thread_id,void *context)
222 <p>Use this pragma if the view is not single threaded:</p>
228 <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>
230 <p>The format of the DuplexTransferWandViewIterator method is:</p>
233 MagickBooleanType DuplexTransferWandViewIterator(WandView *source,
234 WandView *duplex,WandView *destination,
235 DuplexTransferWandViewMethod transfer,void *context)
238 <p>A description of each parameter follows:</p></ol>
241 <ol><p>the source wand view.</p></ol>
244 <ol><p>the duplex wand view.</p></ol>
247 <ol><p>the destination wand view.</p></ol>
250 <ol><p>the transfer callback method.</p></ol>
253 <ol><p>the user defined context.</p></ol>
256 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
257 _8c.html" target="source" name="GetWandViewException">GetWandViewException</a></h2>
258 <div class="doc-section">
260 <p>GetWandViewException() returns the severity, reason, and description of any error that occurs when utilizing a wand view.</p></ol>
262 <p>The format of the GetWandViewException method is:</p>
265 char *GetWandViewException(const PixelWand *wand_view,
266 ExceptionType *severity)
269 <p>A description of each parameter follows:</p></ol>
272 <ol><p>the pixel wand_view.</p></ol>
275 <ol><p>the severity of the error is returned here.</p></ol>
278 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
279 _8c.html" target="source" name="GetWandViewExtent">GetWandViewExtent</a></h2>
280 <div class="doc-section">
282 <p>GetWandViewExtent() returns the wand view extent.</p></ol>
284 <p>The format of the GetWandViewExtent method is:</p>
287 RectangleInfo GetWandViewExtent(const WandView *wand_view)
290 <p>A description of each parameter follows:</p></ol>
293 <ol><p>the wand view.</p></ol>
296 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
297 _8c.html" target="source" name="GetWandViewIterator">GetWandViewIterator</a></h2>
298 <div class="doc-section">
300 <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>
302 <p>The callback signature is:</p>
305 MagickBooleanType GetImageViewMethod(const WandView *source,
306 const ssize_t y,const int thread_id,void *context)
309 <p>Use this pragma if the view is not single threaded:</p>
315 <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>
317 <p>The format of the GetWandViewIterator method is:</p>
320 MagickBooleanType GetWandViewIterator(WandView *source,
321 GetWandViewMethod get,void *context)
324 <p>A description of each parameter follows:</p></ol>
327 <ol><p>the source wand view.</p></ol>
330 <ol><p>the get callback method.</p></ol>
333 <ol><p>the user defined context.</p></ol>
336 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
337 _8c.html" target="source" name="GetWandViewPixels">GetWandViewPixels</a></h2>
338 <div class="doc-section">
340 <p>GetWandViewPixels() returns the wand view pixel_wands.</p></ol>
342 <p>The format of the GetWandViewPixels method is:</p>
345 PixelWand *GetWandViewPixels(const WandView *wand_view)
348 <p>A description of each parameter follows:</p></ol>
351 <ol><p>the wand view.</p></ol>
354 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
355 _8c.html" target="source" name="GetWandViewWand">GetWandViewWand</a></h2>
356 <div class="doc-section">
358 <p>GetWandViewWand() returns the magick wand associated with the wand view.</p></ol>
360 <p>The format of the GetWandViewWand method is:</p>
363 MagickWand *GetWandViewWand(const WandView *wand_view)
366 <p>A description of each parameter follows:</p></ol>
369 <ol><p>the wand view.</p></ol>
372 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
373 _8c.html" target="source" name="IsWandView">IsWandView</a></h2>
374 <div class="doc-section">
376 <p>IsWandView() returns MagickTrue if the the parameter is verified as a wand view object.</p></ol>
378 <p>The format of the IsWandView method is:</p>
381 MagickBooleanType IsWandView(const WandView *wand_view)
384 <p>A description of each parameter follows:</p></ol>
387 <ol><p>the wand view.</p></ol>
390 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
391 _8c.html" target="source" name="NewWandView">NewWandView</a></h2>
392 <div class="doc-section">
394 <p>NewWandView() returns a wand view required for all other methods in the Wand View API.</p></ol>
396 <p>The format of the NewWandView method is:</p>
399 WandView *NewWandView(MagickWand *wand)
402 <p>A description of each parameter follows:</p></ol>
405 <ol><p>the wand.</p></ol>
408 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
409 _8c.html" target="source" name="NewWandViewExtent">NewWandViewExtent</a></h2>
410 <div class="doc-section">
412 <p>NewWandViewExtent() returns a wand view required for all other methods in the Wand View API.</p></ol>
414 <p>The format of the NewWandViewExtent method is:</p>
417 WandView *NewWandViewExtent(MagickWand *wand,const ssize_t x,
418 const ssize_t y,const size_t width,const size_t height)
421 <p>A description of each parameter follows:</p></ol>
424 <ol><p>the magick wand.</p></ol>
426 <h5>x,y,columns,rows</h5>
427 <ol><p>These values define the perimeter of a extent of pixel_wands view.</p></ol>
430 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
431 _8c.html" target="source" name="SetWandViewDescription">SetWandViewDescription</a></h2>
432 <div class="doc-section">
434 <p>SetWandViewDescription() associates a description with an image view.</p></ol>
436 <p>The format of the SetWandViewDescription method is:</p>
439 void SetWandViewDescription(WandView *image_view,const char *description)
442 <p>A description of each parameter follows:</p></ol>
445 <ol><p>the wand view.</p></ol>
448 <ol><p>the wand view description.</p></ol>
451 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
452 _8c.html" target="source" name="SetWandViewIterator">SetWandViewIterator</a></h2>
453 <div class="doc-section">
455 <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>
457 <p>The callback signature is:</p>
460 MagickBooleanType SetImageViewMethod(ImageView *destination,
461 const ssize_t y,const int thread_id,void *context)
464 <p>Use this pragma if the view is not single threaded:</p>
470 <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>
472 <p>The format of the SetWandViewIterator method is:</p>
475 MagickBooleanType SetWandViewIterator(WandView *destination,
476 SetWandViewMethod set,void *context)
479 <p>A description of each parameter follows:</p></ol>
482 <ol><p>the wand view.</p></ol>
485 <ol><p>the set callback method.</p></ol>
488 <ol><p>the user defined context.</p></ol>
491 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
492 _8c.html" target="source" name="TransferWandViewIterator">TransferWandViewIterator</a></h2>
493 <div class="doc-section">
495 <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>
497 <p>The callback signature is:</p>
500 MagickBooleanType TransferImageViewMethod(const WandView *source,
501 WandView *destination,const ssize_t y,const int thread_id,
505 <p>Use this pragma if the view is not single threaded:</p>
511 <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>
513 <p>The format of the TransferWandViewIterator method is:</p>
516 MagickBooleanType TransferWandViewIterator(WandView *source,
517 WandView *destination,TransferWandViewMethod transfer,void *context)
520 <p>A description of each parameter follows:</p></ol>
523 <ol><p>the source wand view.</p></ol>
526 <ol><p>the destination wand view.</p></ol>
529 <ol><p>the transfer callback method.</p></ol>
532 <ol><p>the user defined context.</p></ol>
535 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
536 _8c.html" target="source" name="UpdateWandViewIterator">UpdateWandViewIterator</a></h2>
537 <div class="doc-section">
539 <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>
541 <p>The callback signature is:</p>
544 MagickBooleanType UpdateImageViewMethod(WandView *source,const ssize_t y,
545 const int thread_id,void *context)
548 <p>Use this pragma if the view is not single threaded:</p>
554 <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>
556 <p>The format of the UpdateWandViewIterator method is:</p>
559 MagickBooleanType UpdateWandViewIterator(WandView *source,
560 UpdateWandViewMethod update,void *context)
563 <p>A description of each parameter follows:</p></ol>
566 <ol><p>the source wand view.</p></ol>
569 <ol><p>the update callback method.</p></ol>
572 <ol><p>the user defined context.</p></ol>
579 <span id="linkbar-west"> </span>
\r
580 <span id="linkbar-center">
\r
581 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
582 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
584 <span id="linkbar-east"> </span>
\r
586 <div class="footer">
\r
587 <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
\r
588 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
590 <div style="clear: both; margin: 0; width: 100%; "></div>
\r
591 <script type="text/javascript">
\r
592 var _gaq = _gaq || [];
\r
593 _gaq.push(['_setAccount', 'UA-17690367-1']);
\r
594 _gaq.push(['_trackPageview']);
\r
597 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
\r
598 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
\r
599 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
\r