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.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 127 </div>
 128 <div  class="sponsor">
 129    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
 142 </div>
 143 </div>
 144 </div>
 145 \r
 146 \r
 147 </div>\r
 148 \r
 149 <div class="main">\r
 150 \r
 151 <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>
 152
 153 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 154 _8c.html" target="source" name="ClonePixelView">ClonePixelView</a></h2>
 155 <div class="doc-section">
 156
 157 <p>ClonePixelView() makes a copy of the specified pixel view.</p></ol>
 158
 159 <p>The format of the ClonePixelView method is:</p>
 160
 161 <pre class="code">
 162   PixelView *ClonePixelView(const PixelView *pixel_view)
 163 </pre>
 164
 165 <p>A description of each parameter follows:</p></ol>
 166
 167 <h5>pixel_view</h5>
 168 <ol><p>the pixel view.</p></ol>
 169
 170  </div>
 171 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 172 _8c.html" target="source" name="DestroyPixelView">DestroyPixelView</a></h2>
 173 <div class="doc-section">
 174
 175 <p>DestroyPixelView() deallocates memory associated with a pixel view.</p></ol>
 176
 177 <p>The format of the DestroyPixelView method is:</p>
 178
 179 <pre class="code">
 180   PixelView *DestroyPixelView(PixelView *pixel_view,
 181     const unsigned long number_wands,const unsigned long number_threads)
 182 </pre>
 183
 184 <p>A description of each parameter follows:</p></ol>
 185
 186 <h5>pixel_view</h5>
 187 <ol><p>the pixel view.</p></ol>
 188
 189 <h5>number_wand</h5>
 190 <ol><p>the number of pixel wands.</p></ol>
 191
 192 <h5>number_threads</h5>
 193 <ol><p>number of threads.</p></ol>
 194
 195  </div>
 196 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 197 _8c.html" target="source" name="DuplexTransferPixelViewIterator">DuplexTransferPixelViewIterator</a></h2>
 198 <div class="doc-section">
 199
 200 <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>
 201
 202 <p>Use this pragma:</p>
 203
 204 <pre class="text">
 205       #pragma omp critical
 206 </pre>
 207
 208 <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>
 209
 210 <p>The format of the DuplexTransferPixelViewIterator method is:</p>
 211
 212 <pre class="code">
 213   MagickBooleanType DuplexTransferPixelViewIterator(PixelView *source,
 214     PixelView *duplex,PixelView *destination,
 215     DuplexTransferPixelViewMethod transfer,void *context)
 216 </pre>
 217
 218 <p>A description of each parameter follows:</p></ol>
 219
 220 <h5>source</h5>
 221 <ol><p>the source pixel view.</p></ol>
 222
 223 <h5>duplex</h5>
 224 <ol><p>the duplex pixel view.</p></ol>
 225
 226 <h5>destination</h5>
 227 <ol><p>the destination pixel view.</p></ol>
 228
 229 <h5>transfer</h5>
 230 <ol><p>the transfer callback method.</p></ol>
 231
 232 <h5>context</h5>
 233 <ol><p>the user defined context.</p></ol>
 234
 235  </div>
 236 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 237 _8c.html" target="source" name="GetPixelViewException">GetPixelViewException</a></h2>
 238 <div class="doc-section">
 239
 240 <p>GetPixelViewException() returns the severity, reason, and description of any error that occurs when utilizing a pixel view.</p></ol>
 241
 242 <p>The format of the GetPixelViewException method is:</p>
 243
 244 <pre class="code">
 245   char *GetPixelViewException(const PixelWand *pixel_view,
 246     ExceptionType *severity)
 247 </pre>
 248
 249 <p>A description of each parameter follows:</p></ol>
 250
 251 <h5>pixel_view</h5>
 252 <ol><p>the pixel pixel_view.</p></ol>
 253
 254 <h5>severity</h5>
 255 <ol><p>the severity of the error is returned here.</p></ol>
 256
 257  </div>
 258 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 259 _8c.html" target="source" name="GetPixelViewHeight">GetPixelViewHeight</a></h2>
 260 <div class="doc-section">
 261
 262 <p>GetPixelViewHeight() returns the pixel view height.</p></ol>
 263
 264 <p>The format of the GetPixelViewHeight method is:</p>
 265
 266 <pre class="code">
 267   unsigned long GetPixelViewHeight(const PixelView *pixel_view)
 268 </pre>
 269
 270 <p>A description of each parameter follows:</p></ol>
 271
 272 <h5>pixel_view</h5>
 273 <ol><p>the pixel view.</p></ol>
 274
 275  </div>
 276 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 277 _8c.html" target="source" name="GetPixelViewIterator">GetPixelViewIterator</a></h2>
 278 <div class="doc-section">
 279
 280 <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>
 281
 282 <p>Use this pragma:</p>
 283
 284 <pre class="text">
 285       #pragma omp critical
 286 </pre>
 287
 288 <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>
 289
 290 <p>The format of the GetPixelViewIterator method is:</p>
 291
 292 <pre class="code">
 293   MagickBooleanType GetPixelViewIterator(PixelView *source,
 294     GetPixelViewMethod get,void *context)
 295 </pre>
 296
 297 <p>A description of each parameter follows:</p></ol>
 298
 299 <h5>source</h5>
 300 <ol><p>the source pixel view.</p></ol>
 301
 302 <h5>get</h5>
 303 <ol><p>the get callback method.</p></ol>
 304
 305 <h5>context</h5>
 306 <ol><p>the user defined context.</p></ol>
 307
 308  </div>
 309 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 310 _8c.html" target="source" name="GetPixelViewPixels">GetPixelViewPixels</a></h2>
 311 <div class="doc-section">
 312
 313 <p>GetPixelViewPixels() returns the pixel view pixel_wands.</p></ol>
 314
 315 <p>The format of the GetPixelViewPixels method is:</p>
 316
 317 <pre class="code">
 318   PixelWand *GetPixelViewPixels(const PixelView *pixel_view)
 319 </pre>
 320
 321 <p>A description of each parameter follows:</p></ol>
 322
 323 <h5>pixel_view</h5>
 324 <ol><p>the pixel view.</p></ol>
 325
 326  </div>
 327 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 328 _8c.html" target="source" name="GetPixelViewWand">GetPixelViewWand</a></h2>
 329 <div class="doc-section">
 330
 331 <p>GetPixelViewWand() returns the magick wand associated with the pixel view.</p></ol>
 332
 333 <p>The format of the GetPixelViewWand method is:</p>
 334
 335 <pre class="code">
 336   MagickWand *GetPixelViewWand(const PixelView *pixel_view)
 337 </pre>
 338
 339 <p>A description of each parameter follows:</p></ol>
 340
 341 <h5>pixel_view</h5>
 342 <ol><p>the pixel view.</p></ol>
 343
 344  </div>
 345 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 346 _8c.html" target="source" name="GetPixelViewWidth">GetPixelViewWidth</a></h2>
 347 <div class="doc-section">
 348
 349 <p>GetPixelViewWidth() returns the pixel view width.</p></ol>
 350
 351 <p>The format of the GetPixelViewWidth method is:</p>
 352
 353 <pre class="code">
 354   unsigned long GetPixelViewWidth(const PixelView *pixel_view)
 355 </pre>
 356
 357 <p>A description of each parameter follows:</p></ol>
 358
 359 <h5>pixel_view</h5>
 360 <ol><p>the pixel view.</p></ol>
 361
 362  </div>
 363 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 364 _8c.html" target="source" name="GetPixelViewX">GetPixelViewX</a></h2>
 365 <div class="doc-section">
 366
 367 <p>GetPixelViewX() returns the pixel view x offset.</p></ol>
 368
 369 <p>The format of the GetPixelViewX method is:</p>
 370
 371 <pre class="code">
 372   long GetPixelViewX(const PixelView *pixel_view)
 373 </pre>
 374
 375 <p>A description of each parameter follows:</p></ol>
 376
 377 <h5>pixel_view</h5>
 378 <ol><p>the pixel view.</p></ol>
 379
 380  </div>
 381 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 382 _8c.html" target="source" name="GetPixelViewY">GetPixelViewY</a></h2>
 383 <div class="doc-section">
 384
 385 <p>GetPixelViewY() returns the pixel view y offset.</p></ol>
 386
 387 <p>The format of the GetPixelViewY method is:</p>
 388
 389 <pre class="code">
 390   long GetPixelViewY(const PixelView *pixel_view)
 391 </pre>
 392
 393 <p>A description of each parameter follows:</p></ol>
 394
 395 <h5>pixel_view</h5>
 396 <ol><p>the pixel view.</p></ol>
 397
 398  </div>
 399 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 400 _8c.html" target="source" name="IsPixelView">IsPixelView</a></h2>
 401 <div class="doc-section">
 402
 403 <p>IsPixelView() returns MagickTrue if the the parameter is verified as a pixel view container.</p></ol>
 404
 405 <p>The format of the IsPixelView method is:</p>
 406
 407 <pre class="code">
 408   MagickBooleanType IsPixelView(const PixelView *pixel_view)
 409 </pre>
 410
 411 <p>A description of each parameter follows:</p></ol>
 412
 413 <h5>pixel_view</h5>
 414 <ol><p>the pixel view.</p></ol>
 415
 416  </div>
 417 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 418 _8c.html" target="source" name="NewPixelView">NewPixelView</a></h2>
 419 <div class="doc-section">
 420
 421 <p>NewPixelView() returns a pixel view required for all other methods in the Pixel View API.</p></ol>
 422
 423 <p>The format of the NewPixelView method is:</p>
 424
 425 <pre class="code">
 426   PixelView *NewPixelView(MagickWand *wand)
 427 </pre>
 428
 429 <p>A description of each parameter follows:</p></ol>
 430
 431 <h5>wand</h5>
 432 <ol><p>the wand.</p></ol>
 433
 434  </div>
 435 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 436 _8c.html" target="source" name="NewPixelViewRegion">NewPixelViewRegion</a></h2>
 437 <div class="doc-section">
 438
 439 <p>NewPixelViewRegion() returns a pixel view required for all other methods in the Pixel View API.</p></ol>
 440
 441 <p>The format of the NewPixelViewRegion method is:</p>
 442
 443 <pre class="code">
 444   PixelView *NewPixelViewRegion(MagickWand *wand,const long x,
 445     const long y,const unsigned long width,const unsigned long height)
 446 </pre>
 447
 448 <p>A description of each parameter follows:</p></ol>
 449
 450 <h5>wand</h5>
 451 <ol><p>the magick wand.</p></ol>
 452
 453 <h5>x,y,columns,rows</h5>
 454 <ol><p>These values define the perimeter of a region of pixel_wands view.</p></ol>
 455
 456  </div>
 457 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 458 _8c.html" target="source" name="SetPixelViewIterator">SetPixelViewIterator</a></h2>
 459 <div class="doc-section">
 460
 461 <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>
 462
 463 <p>Use this pragma:</p>
 464
 465 <pre class="text">
 466       #pragma omp critical
 467 </pre>
 468
 469 <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>
 470
 471 <p>The format of the SetPixelViewIterator method is:</p>
 472
 473 <pre class="code">
 474   MagickBooleanType SetPixelViewIterator(PixelView *destination,
 475     SetPixelViewMethod set,void *context)
 476 </pre>
 477
 478 <p>A description of each parameter follows:</p></ol>
 479
 480 <h5>destination</h5>
 481 <ol><p>the pixel view.</p></ol>
 482
 483 <h5>set</h5>
 484 <ol><p>the set callback method.</p></ol>
 485
 486 <h5>context</h5>
 487 <ol><p>the user defined context.</p></ol>
 488
 489  </div>
 490 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 491 _8c.html" target="source" name="TransferPixelViewIterator">TransferPixelViewIterator</a></h2>
 492 <div class="doc-section">
 493
 494 <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>
 495
 496 <p>Use this pragma:</p>
 497
 498 <pre class="text">
 499       #pragma omp critical
 500 </pre>
 501
 502 <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>
 503
 504 <p>The format of the TransferPixelViewIterator method is:</p>
 505
 506 <pre class="code">
 507   MagickBooleanType TransferPixelViewIterator(PixelView *source,
 508     PixelView *destination,TransferPixelViewMethod transfer,void *context)
 509 </pre>
 510
 511 <p>A description of each parameter follows:</p></ol>
 512
 513 <h5>source</h5>
 514 <ol><p>the source pixel view.</p></ol>
 515
 516 <h5>destination</h5>
 517 <ol><p>the destination pixel view.</p></ol>
 518
 519 <h5>transfer</h5>
 520 <ol><p>the transfer callback method.</p></ol>
 521
 522 <h5>context</h5>
 523 <ol><p>the user defined context.</p></ol>
 524
 525  </div>
 526 <h2><a href="http://www.imagemagick.org/api/MagickWand/pixel-view
 527 _8c.html" target="source" name="UpdatePixelViewIterator">UpdatePixelViewIterator</a></h2>
 528 <div class="doc-section">
 529
 530 <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>
 531
 532 <p>Use this pragma:</p>
 533
 534 <pre class="text">
 535       #pragma omp critical
 536 </pre>
 537
 538 <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>
 539
 540 <p>The format of the UpdatePixelViewIterator method is:</p>
 541
 542 <pre class="code">
 543   MagickBooleanType UpdatePixelViewIterator(PixelView *source,
 544     UpdatePixelViewMethod update,void *context)
 545 </pre>
 546
 547 <p>A description of each parameter follows:</p></ol>
 548
 549 <h5>source</h5>
 550 <ol><p>the source pixel view.</p></ol>
 551
 552 <h5>update</h5>
 553 <ol><p>the update callback method.</p></ol>
 554
 555 <h5>context</h5>
 556 <ol><p>the user defined context.</p></ol>
 557
 558  </div>
 559 \r
 560 </div>\r
 561 \r
 562 <div id="linkbar">\r
 563  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 564     <span id="linkbar-center">\r
 565       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 566       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 567     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 568     </span>\r
 569     <span id="linkbar-east">&nbsp;</span>\r
 570   </div>\r
 571   <div class="footer">\r
 572     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 573     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 574   </div>\r
 575   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 576 </body>\r
 577 </html>\r