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