granicus.if.org Git - imagemagick/blob - www/api/pixel-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">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" value="application/xhtml+xml" />\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="screen,projection"><!--\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: Pixel 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:, pixel, view, 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="eastbar">\r
  46 \r
  47 <div class="menu">
  48   <a href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
 128 </div>
 129 <div  class="sponsor">
 130   <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 134 </div>
 135 <div  class="sponsor">
 136   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 140 </div>
 141 <div  class="sponsor">
 142   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 143 </div>
 144 <div  class="sponsor">
 145    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 146 </div>
 147 <div  class="sponsor">
 148    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 149 </div>
 150 </div>
 151 </div>
 152 \r
 153 \r
 154 </div>\r
 155 \r
 156 <div class="main">\r
 157 \r
 158 <p class="navigation-index">[<a href="#ClonePixelView">ClonePixelView</a> &bull; <a href="#DestroyPixelView">DestroyPixelView</a> &bull; <a href="#DuplexTransferPixelViewIterator">DuplexTransferPixelViewIterator</a> &bull; <a href="#GetPixelViewException">GetPixelViewException</a> &bull; <a href="#GetPixelViewHeight">GetPixelViewHeight</a> &bull; <a href="#GetPixelViewIterator">GetPixelViewIterator</a> &bull; <a href="#GetPixelViewPixels">GetPixelViewPixels</a> &bull; <a href="#GetPixelViewWand">GetPixelViewWand</a> &bull; <a href="#GetPixelViewWidth">GetPixelViewWidth</a> &bull; <a href="#GetPixelViewX">GetPixelViewX</a> &bull; <a href="#GetPixelViewY">GetPixelViewY</a> &bull; <a href="#IsPixelView">IsPixelView</a> &bull; <a href="#NewPixelView">NewPixelView</a> &bull; <a href="#NewPixelViewRegion">NewPixelViewRegion</a> &bull; <a href="#SetPixelViewIterator">SetPixelViewIterator</a> &bull; <a href="#TransferPixelViewIterator">TransferPixelViewIterator</a> &bull; <a href="#UpdatePixelViewIterator">UpdatePixelViewIterator</a>]</p>
 159
 160 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 161 _8c.html" target="source" name="ClonePixelView">ClonePixelView</a></h2>
 162 <div class="doc-section">
 163
 164 <p>ClonePixelView() makes a copy of the specified pixel view.</p></ol>
 165
 166 <p>The format of the ClonePixelView method is:</p>
 167
 168 <pre class="code">
 169   PixelView *ClonePixelView(const PixelView *pixel_view)
 170 </pre>
 171
 172 <p>A description of each parameter follows:</p></ol>
 173
 174 <h5>pixel_view</h5>
 175 <ol><p>the pixel view.</p></ol>
 176
 177  </div>
 178 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 179 _8c.html" target="source" name="DestroyPixelView">DestroyPixelView</a></h2>
 180 <div class="doc-section">
 181
 182 <p>DestroyPixelView() deallocates memory associated with a pixel view.</p></ol>
 183
 184 <p>The format of the DestroyPixelView method is:</p>
 185
 186 <pre class="code">
 187   PixelView *DestroyPixelView(PixelView *pixel_view,
 188     const unsigned long number_wands,const unsigned long number_threads)
 189 </pre>
 190
 191 <p>A description of each parameter follows:</p></ol>
 192
 193 <h5>pixel_view</h5>
 194 <ol><p>the pixel view.</p></ol>
 195
 196 <h5>number_wand</h5>
 197 <ol><p>the number of pixel wands.</p></ol>
 198
 199 <h5>number_threads</h5>
 200 <ol><p>number of threads.</p></ol>
 201
 202  </div>
 203 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 204 _8c.html" target="source" name="DuplexTransferPixelViewIterator">DuplexTransferPixelViewIterator</a></h2>
 205 <div class="doc-section">
 206
 207 <p>DuplexTransferPixelViewIterator() iterates over three pixel views in parallel and calls your transfer method for each scanline of the view.  The source and duplex pixel region 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 pixel 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>Use this pragma:</p>
 210
 211 <pre class="text">
 212       #pragma omp critical
 213 </pre>
 214
 215 <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>
 216
 217 <p>The format of the DuplexTransferPixelViewIterator method is:</p>
 218
 219 <pre class="code">
 220   MagickBooleanType DuplexTransferPixelViewIterator(PixelView *source,
 221     PixelView *duplex,PixelView *destination,
 222     DuplexTransferPixelViewMethod transfer,void *context)
 223 </pre>
 224
 225 <p>A description of each parameter follows:</p></ol>
 226
 227 <h5>source</h5>
 228 <ol><p>the source pixel view.</p></ol>
 229
 230 <h5>duplex</h5>
 231 <ol><p>the duplex pixel view.</p></ol>
 232
 233 <h5>destination</h5>
 234 <ol><p>the destination pixel view.</p></ol>
 235
 236 <h5>transfer</h5>
 237 <ol><p>the transfer callback method.</p></ol>
 238
 239 <h5>context</h5>
 240 <ol><p>the user defined context.</p></ol>
 241
 242  </div>
 243 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 244 _8c.html" target="source" name="GetPixelViewException">GetPixelViewException</a></h2>
 245 <div class="doc-section">
 246
 247 <p>GetPixelViewException() returns the severity, reason, and description of any error that occurs when utilizing a pixel view.</p></ol>
 248
 249 <p>The format of the GetPixelViewException method is:</p>
 250
 251 <pre class="code">
 252   char *GetPixelViewException(const PixelWand *pixel_view,
 253     ExceptionType *severity)
 254 </pre>
 255
 256 <p>A description of each parameter follows:</p></ol>
 257
 258 <h5>pixel_view</h5>
 259 <ol><p>the pixel pixel_view.</p></ol>
 260
 261 <h5>severity</h5>
 262 <ol><p>the severity of the error is returned here.</p></ol>
 263
 264  </div>
 265 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 266 _8c.html" target="source" name="GetPixelViewHeight">GetPixelViewHeight</a></h2>
 267 <div class="doc-section">
 268
 269 <p>GetPixelViewHeight() returns the pixel view height.</p></ol>
 270
 271 <p>The format of the GetPixelViewHeight method is:</p>
 272
 273 <pre class="code">
 274   unsigned long GetPixelViewHeight(const PixelView *pixel_view)
 275 </pre>
 276
 277 <p>A description of each parameter follows:</p></ol>
 278
 279 <h5>pixel_view</h5>
 280 <ol><p>the pixel view.</p></ol>
 281
 282  </div>
 283 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 284 _8c.html" target="source" name="GetPixelViewIterator">GetPixelViewIterator</a></h2>
 285 <div class="doc-section">
 286
 287 <p>GetPixelViewIterator() iterates over the pixel view in parallel and calls your get method for each scanline of the view.  The pixel region 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>
 288
 289 <p>Use this pragma:</p>
 290
 291 <pre class="text">
 292       #pragma omp critical
 293 </pre>
 294
 295 <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>
 296
 297 <p>The format of the GetPixelViewIterator method is:</p>
 298
 299 <pre class="code">
 300   MagickBooleanType GetPixelViewIterator(PixelView *source,
 301     GetPixelViewMethod get,void *context)
 302 </pre>
 303
 304 <p>A description of each parameter follows:</p></ol>
 305
 306 <h5>source</h5>
 307 <ol><p>the source pixel view.</p></ol>
 308
 309 <h5>get</h5>
 310 <ol><p>the get callback method.</p></ol>
 311
 312 <h5>context</h5>
 313 <ol><p>the user defined context.</p></ol>
 314
 315  </div>
 316 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 317 _8c.html" target="source" name="GetPixelViewPixels">GetPixelViewPixels</a></h2>
 318 <div class="doc-section">
 319
 320 <p>GetPixelViewPixels() returns the pixel view pixel_wands.</p></ol>
 321
 322 <p>The format of the GetPixelViewPixels method is:</p>
 323
 324 <pre class="code">
 325   PixelWand *GetPixelViewPixels(const PixelView *pixel_view)
 326 </pre>
 327
 328 <p>A description of each parameter follows:</p></ol>
 329
 330 <h5>pixel_view</h5>
 331 <ol><p>the pixel view.</p></ol>
 332
 333  </div>
 334 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 335 _8c.html" target="source" name="GetPixelViewWand">GetPixelViewWand</a></h2>
 336 <div class="doc-section">
 337
 338 <p>GetPixelViewWand() returns the magick wand associated with the pixel view.</p></ol>
 339
 340 <p>The format of the GetPixelViewWand method is:</p>
 341
 342 <pre class="code">
 343   MagickWand *GetPixelViewWand(const PixelView *pixel_view)
 344 </pre>
 345
 346 <p>A description of each parameter follows:</p></ol>
 347
 348 <h5>pixel_view</h5>
 349 <ol><p>the pixel view.</p></ol>
 350
 351  </div>
 352 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 353 _8c.html" target="source" name="GetPixelViewWidth">GetPixelViewWidth</a></h2>
 354 <div class="doc-section">
 355
 356 <p>GetPixelViewWidth() returns the pixel view width.</p></ol>
 357
 358 <p>The format of the GetPixelViewWidth method is:</p>
 359
 360 <pre class="code">
 361   unsigned long GetPixelViewWidth(const PixelView *pixel_view)
 362 </pre>
 363
 364 <p>A description of each parameter follows:</p></ol>
 365
 366 <h5>pixel_view</h5>
 367 <ol><p>the pixel view.</p></ol>
 368
 369  </div>
 370 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 371 _8c.html" target="source" name="GetPixelViewX">GetPixelViewX</a></h2>
 372 <div class="doc-section">
 373
 374 <p>GetPixelViewX() returns the pixel view x offset.</p></ol>
 375
 376 <p>The format of the GetPixelViewX method is:</p>
 377
 378 <pre class="code">
 379   long GetPixelViewX(const PixelView *pixel_view)
 380 </pre>
 381
 382 <p>A description of each parameter follows:</p></ol>
 383
 384 <h5>pixel_view</h5>
 385 <ol><p>the pixel view.</p></ol>
 386
 387  </div>
 388 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 389 _8c.html" target="source" name="GetPixelViewY">GetPixelViewY</a></h2>
 390 <div class="doc-section">
 391
 392 <p>GetPixelViewY() returns the pixel view y offset.</p></ol>
 393
 394 <p>The format of the GetPixelViewY method is:</p>
 395
 396 <pre class="code">
 397   long GetPixelViewY(const PixelView *pixel_view)
 398 </pre>
 399
 400 <p>A description of each parameter follows:</p></ol>
 401
 402 <h5>pixel_view</h5>
 403 <ol><p>the pixel view.</p></ol>
 404
 405  </div>
 406 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 407 _8c.html" target="source" name="IsPixelView">IsPixelView</a></h2>
 408 <div class="doc-section">
 409
 410 <p>IsPixelView() returns MagickTrue if the the parameter is verified as a pixel view container.</p></ol>
 411
 412 <p>The format of the IsPixelView method is:</p>
 413
 414 <pre class="code">
 415   MagickBooleanType IsPixelView(const PixelView *pixel_view)
 416 </pre>
 417
 418 <p>A description of each parameter follows:</p></ol>
 419
 420 <h5>pixel_view</h5>
 421 <ol><p>the pixel view.</p></ol>
 422
 423  </div>
 424 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 425 _8c.html" target="source" name="NewPixelView">NewPixelView</a></h2>
 426 <div class="doc-section">
 427
 428 <p>NewPixelView() returns a pixel view required for all other methods in the Pixel View API.</p></ol>
 429
 430 <p>The format of the NewPixelView method is:</p>
 431
 432 <pre class="code">
 433   PixelView *NewPixelView(MagickWand *wand)
 434 </pre>
 435
 436 <p>A description of each parameter follows:</p></ol>
 437
 438 <h5>wand</h5>
 439 <ol><p>the wand.</p></ol>
 440
 441  </div>
 442 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 443 _8c.html" target="source" name="NewPixelViewRegion">NewPixelViewRegion</a></h2>
 444 <div class="doc-section">
 445
 446 <p>NewPixelViewRegion() returns a pixel view required for all other methods in the Pixel View API.</p></ol>
 447
 448 <p>The format of the NewPixelViewRegion method is:</p>
 449
 450 <pre class="code">
 451   PixelView *NewPixelViewRegion(MagickWand *wand,const long x,
 452     const long y,const unsigned long width,const unsigned long height)
 453 </pre>
 454
 455 <p>A description of each parameter follows:</p></ol>
 456
 457 <h5>wand</h5>
 458 <ol><p>the magick wand.</p></ol>
 459
 460 <h5>x,y,columns,rows</h5>
 461 <ol><p>These values define the perimeter of a region of pixel_wands view.</p></ol>
 462
 463  </div>
 464 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 465 _8c.html" target="source" name="SetPixelViewIterator">SetPixelViewIterator</a></h2>
 466 <div class="doc-section">
 467
 468 <p>SetPixelViewIterator() iterates over the pixel view in parallel and calls your set method for each scanline of the view.  The pixel region 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>
 469
 470 <p>Use this pragma:</p>
 471
 472 <pre class="text">
 473       #pragma omp critical
 474 </pre>
 475
 476 <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>
 477
 478 <p>The format of the SetPixelViewIterator method is:</p>
 479
 480 <pre class="code">
 481   MagickBooleanType SetPixelViewIterator(PixelView *destination,
 482     SetPixelViewMethod set,void *context)
 483 </pre>
 484
 485 <p>A description of each parameter follows:</p></ol>
 486
 487 <h5>destination</h5>
 488 <ol><p>the pixel view.</p></ol>
 489
 490 <h5>set</h5>
 491 <ol><p>the set callback method.</p></ol>
 492
 493 <h5>context</h5>
 494 <ol><p>the user defined context.</p></ol>
 495
 496  </div>
 497 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 498 _8c.html" target="source" name="TransferPixelViewIterator">TransferPixelViewIterator</a></h2>
 499 <div class="doc-section">
 500
 501 <p>TransferPixelViewIterator() iterates over two pixel views in parallel and calls your transfer method for each scanline of the view.  The source pixel region 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 pixel 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>
 502
 503 <p>Use this pragma:</p>
 504
 505 <pre class="text">
 506       #pragma omp critical
 507 </pre>
 508
 509 <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>
 510
 511 <p>The format of the TransferPixelViewIterator method is:</p>
 512
 513 <pre class="code">
 514   MagickBooleanType TransferPixelViewIterator(PixelView *source,
 515     PixelView *destination,TransferPixelViewMethod transfer,void *context)
 516 </pre>
 517
 518 <p>A description of each parameter follows:</p></ol>
 519
 520 <h5>source</h5>
 521 <ol><p>the source pixel view.</p></ol>
 522
 523 <h5>destination</h5>
 524 <ol><p>the destination pixel view.</p></ol>
 525
 526 <h5>transfer</h5>
 527 <ol><p>the transfer callback method.</p></ol>
 528
 529 <h5>context</h5>
 530 <ol><p>the user defined context.</p></ol>
 531
 532  </div>
 533 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 534 _8c.html" target="source" name="UpdatePixelViewIterator">UpdatePixelViewIterator</a></h2>
 535 <div class="doc-section">
 536
 537 <p>UpdatePixelViewIterator() iterates over the pixel view in parallel and calls your update method for each scanline of the view.  The pixel region 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>
 538
 539 <p>Use this pragma:</p>
 540
 541 <pre class="text">
 542       #pragma omp critical
 543 </pre>
 544
 545 <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>
 546
 547 <p>The format of the UpdatePixelViewIterator method is:</p>
 548
 549 <pre class="code">
 550   MagickBooleanType UpdatePixelViewIterator(PixelView *source,
 551     UpdatePixelViewMethod update,void *context)
 552 </pre>
 553
 554 <p>A description of each parameter follows:</p></ol>
 555
 556 <h5>source</h5>
 557 <ol><p>the source pixel view.</p></ol>
 558
 559 <h5>update</h5>
 560 <ol><p>the update callback method.</p></ol>
 561
 562 <h5>context</h5>
 563 <ol><p>the user defined context.</p></ol>
 564
 565  </div>
 566 \r
 567 </div>\r
 568 \r
 569 <div id="linkbar">\r
 570  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 571     <span id="linkbar-center">\r
 572       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 573     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 574     </span>\r
 575     <span id="linkbar-east">&nbsp;</span>\r
 576   </div>\r
 577   <div class="footer">\r
 578     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 579     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 580   </div>\r
 581   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 582 </body>\r
 583 </html>\r