granicus.if.org Git - imagemagick/blob - 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   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   8   <style type="text/css" media="all">\r
   9     @import url("../../www/magick.css");\r
  10   </style>\r
  11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  12   <title>ImageMagick: MagickWand, C API for ImageMagick: Wand View Methods</title>
  13   <meta http-equiv="Content-Language" content="en-US"/>
  14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="Generator" content="PHP"/>
  17   <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"/>
  18   <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."/>
  19   <meta name="Rating" content="GENERAL"/>
  20   <meta name="Robots" content="INDEX, FOLLOW"/>
  21   <meta name="Generator" content="ImageMagick Studio LLC"/>
  22   <meta name="Author" content="ImageMagick Studio LLC"/>
  23   <meta name="Revisit-after" content="2 DAYS"/>
  24   <meta name="Resource-type" content="document"/>
  25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  26   <meta name="Distribution" content="Global"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../../index.html">\r
  32   <img src="../../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../../index.html">\r
  41   <img src="../../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="westbar">\r
  46 \r
  47 <div class="menu">
  48   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  53 </div>
  54 <div class="sub">
  55     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  62 </div>
  63 <div class="sep"></div>\r
  64 <div class="menu">
  65   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  66 </div>
  67 <div class="sub">
  68     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  75 </div>
  76 <div class="menu">
  77   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  78 </div>
  79 <div class="sub">
  80     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  90 </div>
  91 <div class="sep"></div>\r
  92 <div  class="menu">
  93    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 100  </div>
 101 <div class="menu">
 102   <a title="Resources" href="../../www/resources.html">Resources</a>
 103 </div>
 104 <div class="menu">
 105   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Download" href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 137 </div>
 138 <div  class="sponsor">
 139    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 140 </div>
 141 <div  class="sponsor">
 142    <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 143 </div>
 144 </div>
 145 </div>
 146 </div>\r
 147 \r
 148 <div class="eastbar">\r
 149   <script type="text/javascript">\r
 150   <!--\r
 151     google_ad_client = "pub-3129977114552745";\r
 152     /* 160x600, created 7/27/10 */\r
 153     google_ad_slot = "0574824969";\r
 154     google_ad_width = 160;\r
 155     google_ad_height = 600;\r
 156   //-->\r
 157   </script>\r
 158   <script type="text/javascript"\r
 159     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 160   </script>\r
 161 </div>\r
 162 \r
 163 <div class="main">\r
 164 \r
 165 <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="#TransferWandViewIterator">TransferWandViewIterator</a> &bull; <a href="#UpdateWandViewIterator">UpdateWandViewIterator</a>]</p>
 166
 167 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 168 _8c.html" target="source" name="CloneWandView">CloneWandView</a></h2>
 169 <div class="doc-section">
 170
 171 <p>CloneWandView() makes a copy of the specified wand view.</p></ol>
 172
 173 <p>The format of the CloneWandView method is:</p>
 174
 175 <pre class="code">
 176   WandView *CloneWandView(const WandView *wand_view)
 177 </pre>
 178
 179 <p>A description of each parameter follows:</p></ol>
 180
 181 <h5>wand_view</h5>
 182 <ol><p>the wand view.</p></ol>
 183
 184  </div>
 185 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 186 _8c.html" target="source" name="DestroyWandView">DestroyWandView</a></h2>
 187 <div class="doc-section">
 188
 189 <p>DestroyWandView() deallocates memory associated with a wand view.</p></ol>
 190
 191 <p>The format of the DestroyWandView method is:</p>
 192
 193 <pre class="code">
 194   WandView *DestroyWandView(WandView *wand_view)
 195 </pre>
 196
 197 <p>A description of each parameter follows:</p></ol>
 198
 199 <h5>wand_view</h5>
 200 <ol><p>the wand view.</p></ol>
 201
 202  </div>
 203 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 204 _8c.html" target="source" name="DuplexTransferWandViewIterator">DuplexTransferWandViewIterator</a></h2>
 205 <div class="doc-section">
 206
 207 <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>
 208
 209 <p>The callback signature is:</p>
 210
 211 <pre class="text">
 212   MagickBooleanType DuplexTransferImageViewMethod(const WandView *source,
 213     const WandView *duplex,WandView *destination,const ssize_t y,
 214     const int thread_id,void *context)
 215 </pre>
 216
 217 <p>Use this pragma if the view is not single threaded:</p>
 218
 219 <pre class="text">
 220       #pragma omp critical
 221 </pre>
 222
 223 <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>
 224
 225 <p>The format of the DuplexTransferWandViewIterator method is:</p>
 226
 227 <pre class="code">
 228   MagickBooleanType DuplexTransferWandViewIterator(WandView *source,
 229     WandView *duplex,WandView *destination,
 230     DuplexTransferWandViewMethod transfer,void *context)
 231 </pre>
 232
 233 <p>A description of each parameter follows:</p></ol>
 234
 235 <h5>source</h5>
 236 <ol><p>the source wand view.</p></ol>
 237
 238 <h5>duplex</h5>
 239 <ol><p>the duplex wand view.</p></ol>
 240
 241 <h5>destination</h5>
 242 <ol><p>the destination wand view.</p></ol>
 243
 244 <h5>transfer</h5>
 245 <ol><p>the transfer callback method.</p></ol>
 246
 247 <h5>context</h5>
 248 <ol><p>the user defined context.</p></ol>
 249
 250  </div>
 251 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 252 _8c.html" target="source" name="GetWandViewException">GetWandViewException</a></h2>
 253 <div class="doc-section">
 254
 255 <p>GetWandViewException() returns the severity, reason, and description of any error that occurs when utilizing a wand view.</p></ol>
 256
 257 <p>The format of the GetWandViewException method is:</p>
 258
 259 <pre class="code">
 260   char *GetWandViewException(const PixelWand *wand_view,
 261     ExceptionType *severity)
 262 </pre>
 263
 264 <p>A description of each parameter follows:</p></ol>
 265
 266 <h5>wand_view</h5>
 267 <ol><p>the pixel wand_view.</p></ol>
 268
 269 <h5>severity</h5>
 270 <ol><p>the severity of the error is returned here.</p></ol>
 271
 272  </div>
 273 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 274 _8c.html" target="source" name="GetWandViewExtent">GetWandViewExtent</a></h2>
 275 <div class="doc-section">
 276
 277 <p>GetWandViewExtent() returns the wand view extent.</p></ol>
 278
 279 <p>The format of the GetWandViewExtent method is:</p>
 280
 281 <pre class="code">
 282   RectangleInfo GetWandViewExtent(const WandView *wand_view)
 283 </pre>
 284
 285 <p>A description of each parameter follows:</p></ol>
 286
 287 <h5>wand_view</h5>
 288 <ol><p>the wand view.</p></ol>
 289
 290  </div>
 291 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 292 _8c.html" target="source" name="GetWandViewIterator">GetWandViewIterator</a></h2>
 293 <div class="doc-section">
 294
 295 <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>
 296
 297 <p>The callback signature is:</p>
 298
 299 <pre class="text">
 300   MagickBooleanType GetImageViewMethod(const WandView *source,
 301     const ssize_t y,const int thread_id,void *context)
 302 </pre>
 303
 304 <p>Use this pragma if the view is not single threaded:</p>
 305
 306 <pre class="text">
 307       #pragma omp critical
 308 </pre>
 309
 310 <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>
 311
 312 <p>The format of the GetWandViewIterator method is:</p>
 313
 314 <pre class="code">
 315   MagickBooleanType GetWandViewIterator(WandView *source,
 316     GetWandViewMethod get,void *context)
 317 </pre>
 318
 319 <p>A description of each parameter follows:</p></ol>
 320
 321 <h5>source</h5>
 322 <ol><p>the source wand view.</p></ol>
 323
 324 <h5>get</h5>
 325 <ol><p>the get callback method.</p></ol>
 326
 327 <h5>context</h5>
 328 <ol><p>the user defined context.</p></ol>
 329
 330  </div>
 331 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 332 _8c.html" target="source" name="GetWandViewPixels">GetWandViewPixels</a></h2>
 333 <div class="doc-section">
 334
 335 <p>GetWandViewPixels() returns the wand view pixel_wands.</p></ol>
 336
 337 <p>The format of the GetWandViewPixels method is:</p>
 338
 339 <pre class="code">
 340   PixelWand *GetWandViewPixels(const WandView *wand_view)
 341 </pre>
 342
 343 <p>A description of each parameter follows:</p></ol>
 344
 345 <h5>wand_view</h5>
 346 <ol><p>the wand view.</p></ol>
 347
 348  </div>
 349 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 350 _8c.html" target="source" name="GetWandViewWand">GetWandViewWand</a></h2>
 351 <div class="doc-section">
 352
 353 <p>GetWandViewWand() returns the magick wand associated with the wand view.</p></ol>
 354
 355 <p>The format of the GetWandViewWand method is:</p>
 356
 357 <pre class="code">
 358   MagickWand *GetWandViewWand(const WandView *wand_view)
 359 </pre>
 360
 361 <p>A description of each parameter follows:</p></ol>
 362
 363 <h5>wand_view</h5>
 364 <ol><p>the wand view.</p></ol>
 365
 366  </div>
 367 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 368 _8c.html" target="source" name="IsWandView">IsWandView</a></h2>
 369 <div class="doc-section">
 370
 371 <p>IsWandView() returns MagickTrue if the the parameter is verified as a wand view object.</p></ol>
 372
 373 <p>The format of the IsWandView method is:</p>
 374
 375 <pre class="code">
 376   MagickBooleanType IsWandView(const WandView *wand_view)
 377 </pre>
 378
 379 <p>A description of each parameter follows:</p></ol>
 380
 381 <h5>wand_view</h5>
 382 <ol><p>the wand view.</p></ol>
 383
 384  </div>
 385 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 386 _8c.html" target="source" name="NewWandView">NewWandView</a></h2>
 387 <div class="doc-section">
 388
 389 <p>NewWandView() returns a wand view required for all other methods in the Wand View API.</p></ol>
 390
 391 <p>The format of the NewWandView method is:</p>
 392
 393 <pre class="code">
 394   WandView *NewWandView(MagickWand *wand)
 395 </pre>
 396
 397 <p>A description of each parameter follows:</p></ol>
 398
 399 <h5>wand</h5>
 400 <ol><p>the wand.</p></ol>
 401
 402  </div>
 403 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 404 _8c.html" target="source" name="NewWandViewExtent">NewWandViewExtent</a></h2>
 405 <div class="doc-section">
 406
 407 <p>NewWandViewExtent() returns a wand view required for all other methods in the Wand View API.</p></ol>
 408
 409 <p>The format of the NewWandViewExtent method is:</p>
 410
 411 <pre class="code">
 412   WandView *NewWandViewExtent(MagickWand *wand,const ssize_t x,
 413     const ssize_t y,const size_t width,const size_t height)
 414 </pre>
 415
 416 <p>A description of each parameter follows:</p></ol>
 417
 418 <h5>wand</h5>
 419 <ol><p>the magick wand.</p></ol>
 420
 421 <h5>x,y,columns,rows</h5>
 422 <ol><p>These values define the perimeter of a extent of pixel_wands view.</p></ol>
 423
 424  </div>
 425 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 426 _8c.html" target="source" name="SetWandViewDescription">SetWandViewDescription</a></h2>
 427 <div class="doc-section">
 428
 429 <p>SetWandViewDescription() associates a description with an image view.</p></ol>
 430
 431 <p>The format of the SetWandViewDescription method is:</p>
 432
 433 <pre class="code">
 434   void SetWandViewDescription(WandView *image_view,const char *description)
 435 </pre>
 436
 437 <p>A description of each parameter follows:</p></ol>
 438
 439 <h5>wand_view</h5>
 440 <ol><p>the wand view.</p></ol>
 441
 442 <h5>description</h5>
 443 <ol><p>the wand view description.</p></ol>
 444
 445  </div>
 446 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 447 _8c.html" target="source" name="SetWandViewIterator">SetWandViewIterator</a></h2>
 448 <div class="doc-section">
 449
 450 <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>
 451
 452 <p>The callback signature is:</p>
 453
 454 <pre class="text">
 455   MagickBooleanType SetImageViewMethod(ImageView *destination,
 456     const ssize_t y,const int thread_id,void *context)
 457 </pre>
 458
 459 <p>Use this pragma if the view is not single threaded:</p>
 460
 461 <pre class="text">
 462       #pragma omp critical
 463 </pre>
 464
 465 <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>
 466
 467 <p>The format of the SetWandViewIterator method is:</p>
 468
 469 <pre class="code">
 470   MagickBooleanType SetWandViewIterator(WandView *destination,
 471     SetWandViewMethod set,void *context)
 472 </pre>
 473
 474 <p>A description of each parameter follows:</p></ol>
 475
 476 <h5>destination</h5>
 477 <ol><p>the wand view.</p></ol>
 478
 479 <h5>set</h5>
 480 <ol><p>the set callback method.</p></ol>
 481
 482 <h5>context</h5>
 483 <ol><p>the user defined context.</p></ol>
 484
 485  </div>
 486 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 487 _8c.html" target="source" name="TransferWandViewIterator">TransferWandViewIterator</a></h2>
 488 <div class="doc-section">
 489
 490 <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>
 491
 492 <p>The callback signature is:</p>
 493
 494 <pre class="text">
 495   MagickBooleanType TransferImageViewMethod(const WandView *source,
 496     WandView *destination,const ssize_t y,const int thread_id,
 497     void *context)
 498 </pre>
 499
 500 <p>Use this pragma if the view is not single threaded:</p>
 501
 502 <pre class="text">
 503       #pragma omp critical
 504 </pre>
 505
 506 <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>
 507
 508 <p>The format of the TransferWandViewIterator method is:</p>
 509
 510 <pre class="code">
 511   MagickBooleanType TransferWandViewIterator(WandView *source,
 512     WandView *destination,TransferWandViewMethod transfer,void *context)
 513 </pre>
 514
 515 <p>A description of each parameter follows:</p></ol>
 516
 517 <h5>source</h5>
 518 <ol><p>the source wand view.</p></ol>
 519
 520 <h5>destination</h5>
 521 <ol><p>the destination wand view.</p></ol>
 522
 523 <h5>transfer</h5>
 524 <ol><p>the transfer callback method.</p></ol>
 525
 526 <h5>context</h5>
 527 <ol><p>the user defined context.</p></ol>
 528
 529  </div>
 530 <h2><a href="http://www.imagemagick.org/api/MagickWand/wand-view
 531 _8c.html" target="source" name="UpdateWandViewIterator">UpdateWandViewIterator</a></h2>
 532 <div class="doc-section">
 533
 534 <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>
 535
 536 <p>The callback signature is:</p>
 537
 538 <pre class="text">
 539   MagickBooleanType UpdateImageViewMethod(WandView *source,const ssize_t y,
 540     const int thread_id,void *context)
 541 </pre>
 542
 543 <p>Use this pragma if the view is not single threaded:</p>
 544
 545 <pre class="text">
 546       #pragma omp critical
 547 </pre>
 548
 549 <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>
 550
 551 <p>The format of the UpdateWandViewIterator method is:</p>
 552
 553 <pre class="code">
 554   MagickBooleanType UpdateWandViewIterator(WandView *source,
 555     UpdateWandViewMethod update,void *context)
 556 </pre>
 557
 558 <p>A description of each parameter follows:</p></ol>
 559
 560 <h5>source</h5>
 561 <ol><p>the source wand view.</p></ol>
 562
 563 <h5>update</h5>
 564 <ol><p>the update callback method.</p></ol>
 565
 566 <h5>context</h5>
 567 <ol><p>the user defined context.</p></ol>
 568
 569  </div>
 570 \r
 571 </div>\r
 572 \r
 573 <div id="linkbar">\r
 574     <span id="linkbar-west">&nbsp;</span>\r
 575     <span id="linkbar-center">\r
 576       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 577     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 578     </span>\r
 579     <span id="linkbar-east">&nbsp;</span>\r
 580   </div>\r
 581   <div class="footer">\r
 582     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 583     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 584   </div>\r
 585   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 586 </body>\r
 587 </html>\r