granicus.if.org Git - imagemagick/blob - www/api/cache.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: MagickCore, C API for ImageMagick: Get or Set Image Pixels</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="magickcore, c, api, for, imagemagick:, get, or, set, image, pixels, 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="#AcquirePixelCacheNexus">AcquirePixelCacheNexus</a> &bull; <a href="#GetAuthenticIndexQueue">GetAuthenticIndexQueue</a> &bull; <a href="#GetAuthenticPixelQueue">GetAuthenticPixelQueue</a> &bull; <a href="#GetAuthenticPixels">GetAuthenticPixels</a> &bull; <a href="#GetOneAuthenticPixel">GetOneAuthenticPixel</a> &bull; <a href="#GetOneVirtualMagickPixel">GetOneVirtualMagickPixel</a> &bull; <a href="#GetOneVirtualMethodPixel">GetOneVirtualMethodPixel</a> &bull; <a href="#GetOneVirtualPixel">GetOneVirtualPixel</a> &bull; <a href="#GetVirtualIndexQueue">GetVirtualIndexQueue</a> &bull; <a href="#VirtualPixelModulo">VirtualPixelModulo</a> &bull; <a href="#GetVirtualPixelQueue">GetVirtualPixelQueue</a> &bull; <a href="#GetVirtualPixels">GetVirtualPixels</a> &bull; <a href="#QueueAuthenticPixels">QueueAuthenticPixels</a> &bull; <a href="#SetPixelCacheVirtualMethod">SetPixelCacheVirtualMethod</a> &bull; <a href="#SyncAuthenticPixels">SyncAuthenticPixels</a>]</p>
 152
 153 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 154 _8c.html" target="source" name="AcquirePixelCacheNexus">AcquirePixelCacheNexus</a></h2>
 155 <div class="doc-section">
 156
 157 <p>AcquirePixelCacheNexus() allocates the NexusInfo structure.</p></ol>
 158
 159 <p>The format of the AcquirePixelCacheNexus method is:</p>
 160
 161 <pre class="code">
 162   NexusInfo **AcquirePixelCacheNexus(const unsigned long number_threads)
 163 </pre>
 164
 165 <p>A description of each parameter follows:</p></ol>
 166
 167 <h5>number_threads</h5>
 168 <ol><p>the number of nexus threads.</p></ol>
 169
 170  </div>
 171 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 172 _8c.html" target="source" name="GetAuthenticIndexQueue">GetAuthenticIndexQueue</a></h2>
 173 <div class="doc-section">
 174
 175 <p>GetAuthenticIndexQueue() returns the authentic black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().  NULL is returned if the black channel or colormap indexes are not available.</p></ol>
 176
 177 <p>The format of the GetAuthenticIndexQueue() method is:</p>
 178
 179 <pre class="code">
 180   IndexPacket *GetAuthenticIndexQueue(const Image *image)
 181 </pre>
 182
 183 <p>A description of each parameter follows:</p></ol>
 184
 185 <h5>image</h5>
 186 <ol><p>the image.</p></ol>
 187
 188  </div>
 189 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 190 _8c.html" target="source" name="GetAuthenticPixelQueue">GetAuthenticPixelQueue</a></h2>
 191 <div class="doc-section">
 192
 193 <p>GetAuthenticPixelQueue() returns the authentic pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
 194
 195 <p>The format of the GetAuthenticPixelQueue() method is:</p>
 196
 197 <pre class="code">
 198   PixelPacket *GetAuthenticPixelQueue(const Image image)
 199 </pre>
 200
 201 <p>A description of each parameter follows:</p></ol>
 202
 203 <h5>image</h5>
 204 <ol><p>the image.</p></ol>
 205
 206  </div>
 207 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 208 _8c.html" target="source" name="GetAuthenticPixels">GetAuthenticPixels</a></h2>
 209 <div class="doc-section">
 210
 211 <p>GetAuthenticPixels() obtains a pixel region for read/write access. If the region is successfully accessed, a pointer to a PixelPacket array representing the region is returned, otherwise NULL is returned.</p></ol>
 212
 213 <p>The returned pointer may point to a temporary working copy of the pixels or it may point to the original pixels in memory. Performance is maximized if the selected region is part of one row, or one or more full rows, since then there is opportunity to access the pixels in-place (without a copy) if the image is in RAM, or in a memory-mapped file. The returned pointer should *never* be deallocated by the user.</p></ol>
 214
 215 <p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or if the storage class is PseduoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to obtain the black color component or colormap indexes (of type IndexPacket) corresponding to the region.  Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.</p></ol>
 216
 217 <p>The format of the GetAuthenticPixels() method is:</p>
 218
 219 <pre class="code">
 220   PixelPacket *GetAuthenticPixels(Image *image,const long x,const long y,
 221     const unsigned long columns,const unsigned long rows,
 222     ExceptionInfo *exception)
 223 </pre>
 224
 225 <p>A description of each parameter follows:</p></ol>
 226
 227 <h5>image</h5>
 228 <ol><p>the image.</p></ol>
 229
 230 <h5>x,y,columns,rows</h5>
 231 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 232
 233 <h5>exception</h5>
 234 <ol><p>return any errors or warnings in this structure.</p></ol>
 235
 236  </div>
 237 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 238 _8c.html" target="source" name="GetOneAuthenticPixel">GetOneAuthenticPixel</a></h2>
 239 <div class="doc-section">
 240
 241 <p>GetOneAuthenticPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.</p></ol>
 242
 243 <p>The format of the GetOneAuthenticPixel() method is:</p>
 244
 245 <pre class="code">
 246   MagickBooleanType GetOneAuthenticPixel(const Image image,const long x,
 247     const long y,PixelPacket *pixel,ExceptionInfo *exception)
 248 </pre>
 249
 250 <p>A description of each parameter follows:</p></ol>
 251
 252 <h5>image</h5>
 253 <ol><p>the image.</p></ol>
 254
 255 <h5>x,y</h5>
 256 <ol><p>These values define the location of the pixel to return.</p></ol>
 257
 258 <h5>pixel</h5>
 259 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 260
 261 <h5>exception</h5>
 262 <ol><p>return any errors or warnings in this structure.</p></ol>
 263
 264  </div>
 265 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 266 _8c.html" target="source" name="GetOneVirtualMagickPixel">GetOneVirtualMagickPixel</a></h2>
 267 <div class="doc-section">
 268
 269 <p>GetOneVirtualMagickPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.  If you plan to modify the pixel, use GetOneAuthenticPixel() instead.</p></ol>
 270
 271 <p>The format of the GetOneVirtualMagickPixel() method is:</p>
 272
 273 <pre class="code">
 274   MagickBooleanType GetOneVirtualMagickPixel(const Image image,
 275     const long x,const long y,MagickPixelPacket *pixel,
 276     ExceptionInfo exception)
 277 </pre>
 278
 279 <p>A description of each parameter follows:</p></ol>
 280
 281 <h5>image</h5>
 282 <ol><p>the image.</p></ol>
 283
 284 <h5>x,y</h5>
 285 <ol><p>these values define the location of the pixel to return.</p></ol>
 286
 287 <h5>pixel</h5>
 288 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 289
 290 <h5>exception</h5>
 291 <ol><p>return any errors or warnings in this structure.</p></ol>
 292
 293  </div>
 294 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 295 _8c.html" target="source" name="GetOneVirtualMethodPixel">GetOneVirtualMethodPixel</a></h2>
 296 <div class="doc-section">
 297
 298 <p>GetOneVirtualMethodPixel() returns a single pixel at the specified (x,y) location as defined by specified pixel method.  The image background color is returned if an error occurs.  If you plan to modify the pixel, use GetOneAuthenticPixel() instead.</p></ol>
 299
 300 <p>The format of the GetOneVirtualMethodPixel() method is:</p>
 301
 302 <pre class="code">
 303   MagickBooleanType GetOneVirtualMethodPixel(const Image image,
 304     const VirtualPixelMethod virtual_pixel_method,const long x,
 305     const long y,Pixelpacket *pixel,ExceptionInfo exception)
 306 </pre>
 307
 308 <p>A description of each parameter follows:</p></ol>
 309
 310 <h5>image</h5>
 311 <ol><p>the image.</p></ol>
 312
 313 <h5>virtual_pixel_method</h5>
 314 <ol><p>the virtual pixel method.</p></ol>
 315
 316 <h5>x,y</h5>
 317 <ol><p>These values define the location of the pixel to return.</p></ol>
 318
 319 <h5>pixel</h5>
 320 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 321
 322 <h5>exception</h5>
 323 <ol><p>return any errors or warnings in this structure.</p></ol>
 324
 325  </div>
 326 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 327 _8c.html" target="source" name="GetOneVirtualPixel">GetOneVirtualPixel</a></h2>
 328 <div class="doc-section">
 329
 330 <p>GetOneVirtualPixel() returns a single virtual pixel at the specified (x,y) location.  The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneAuthenticPixel() instead.</p></ol>
 331
 332 <p>The format of the GetOneVirtualPixel() method is:</p>
 333
 334 <pre class="code">
 335   MagickBooleanType GetOneVirtualPixel(const Image image,const long x,
 336     const long y,PixelPacket *pixel,ExceptionInfo exception)
 337 </pre>
 338
 339 <p>A description of each parameter follows:</p></ol>
 340
 341 <h5>image</h5>
 342 <ol><p>the image.</p></ol>
 343
 344 <h5>x,y</h5>
 345 <ol><p>These values define the location of the pixel to return.</p></ol>
 346
 347 <h5>pixel</h5>
 348 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 349
 350 <h5>exception</h5>
 351 <ol><p>return any errors or warnings in this structure.</p></ol>
 352
 353  </div>
 354 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 355 _8c.html" target="source" name="GetVirtualIndexQueue">GetVirtualIndexQueue</a></h2>
 356 <div class="doc-section">
 357
 358 <p>GetVirtualIndexQueue() returns the virtual black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().  NULL is returned if the black channel or colormap indexes are not available.</p></ol>
 359
 360 <p>The format of the GetVirtualIndexQueue() method is:</p>
 361
 362 <pre class="code">
 363   const IndexPacket *GetVirtualIndexQueue(const Image *image)
 364 </pre>
 365
 366 <p>A description of each parameter follows:</p></ol>
 367
 368 <h5>image</h5>
 369 <ol><p>the image.</p></ol>
 370
 371  </div>
 372 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 373 _8c.html" target="source" name="VirtualPixelModulo">VirtualPixelModulo</a></h2>
 374 <div class="doc-section">
 375
 376 <p>VirtualPixelModulo() computes the remainder of dividing offset by extent.  It returns not only the quotient (tile the offset falls in) but also the positive remainer within that tile such that 0 <= remainder < extent.  This method is essentially a ldiv() using a floored modulo division rather than the normal default truncated modulo division. </p>
 377  </div>
 378 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 379 _8c.html" target="source" name="GetVirtualPixelQueue">GetVirtualPixelQueue</a></h2>
 380 <div class="doc-section">
 381
 382 <p>GetVirtualPixelQueue() returns the virtual pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
 383
 384 <p>The format of the GetVirtualPixelQueue() method is:</p>
 385
 386 <pre class="code">
 387   const PixelPacket *GetVirtualPixelQueue(const Image image)
 388 </pre>
 389
 390 <p>A description of each parameter follows:</p></ol>
 391
 392 <h5>image</h5>
 393 <ol><p>the image.</p></ol>
 394
 395  </div>
 396 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 397 _8c.html" target="source" name="GetVirtualPixels">GetVirtualPixels</a></h2>
 398 <div class="doc-section">
 399
 400 <p>GetVirtualPixels() returns an immutable pixel region. If the region is successfully accessed, a pointer to it is returned, otherwise NULL is returned. The returned pointer may point to a temporary working copy of the pixels or it may point to the original pixels in memory. Performance is maximized if the selected region is part of one row, or one or more full rows, since there is opportunity to access the pixels in-place (without a copy) if the image is in RAM, or in a memory-mapped file.  The returned pointer should *never* be deallocated by the user.</p></ol>
 401
 402 <p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket.  If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to access the black color component or to obtain the colormap indexes (of type IndexPacket) corresponding to the region.</p></ol>
 403
 404 <p>If you plan to modify the pixels, use GetAuthenticPixels() instead.</p></ol>
 405
 406 <p>Note, the GetVirtualPixels() and GetAuthenticPixels() methods are not thread- safe.  In a threaded environment, use GetCacheViewVirtualPixels() or GetCacheViewAuthenticPixels() instead.</p></ol>
 407
 408 <p>The format of the GetVirtualPixels() method is:</p>
 409
 410 <pre class="code">
 411   const PixelPacket *GetVirtualPixels(const Image *image,const long x,
 412     const long y,const unsigned long columns,const unsigned long rows,
 413     ExceptionInfo *exception)
 414 </pre>
 415
 416 <p>A description of each parameter follows:</p></ol>
 417
 418 <h5>image</h5>
 419 <ol><p>the image.</p></ol>
 420
 421 <h5>x,y,columns,rows</h5>
 422 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 423
 424 <h5>exception</h5>
 425 <ol><p>return any errors or warnings in this structure.</p></ol>
 426
 427  </div>
 428 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 429 _8c.html" target="source" name="QueueAuthenticPixels">QueueAuthenticPixels</a></h2>
 430 <div class="doc-section">
 431
 432 <p>QueueAuthenticPixels() queues a mutable pixel region.  If the region is successfully intialized a pointer to a PixelPacket array representing the region is returned, otherwise NULL is returned.  The returned pointer may point to a temporary working buffer for the pixels or it may point to the final location of the pixels in memory.</p></ol>
 433
 434 <p>Write-only access means that any existing pixel values corresponding to the region are ignored.  This is useful if the initial image is being created from scratch, or if the existing pixel values are to be completely replaced without need to refer to their pre-existing values. The application is free to read and write the pixel buffer returned by QueueAuthenticPixels() any way it pleases. QueueAuthenticPixels() does not initialize the pixel array values. Initializing pixel array values is the application's responsibility.</p></ol>
 435
 436 <p>Performance is maximized if the selected region is part of one row, or one or more full rows, since then there is opportunity to access the pixels in-place (without a copy) if the image is in RAM, or in a memory-mapped file. The returned pointer should *never* be deallocated by the user.</p></ol>
 437
 438 <p>Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to obtain the black color component or the colormap indexes (of type IndexPacket) corresponding to the region.  Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.</p></ol>
 439
 440 <p>The format of the QueueAuthenticPixels() method is:</p>
 441
 442 <pre class="code">
 443   PixelPacket *QueueAuthenticPixels(Image *image,const long x,const long y,
 444     const unsigned long columns,const unsigned long rows,
 445     ExceptionInfo *exception)
 446 </pre>
 447
 448 <p>A description of each parameter follows:</p></ol>
 449
 450 <h5>image</h5>
 451 <ol><p>the image.</p></ol>
 452
 453 <h5>x,y,columns,rows</h5>
 454 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 455
 456 <h5>exception</h5>
 457 <ol><p>return any errors or warnings in this structure.</p></ol>
 458
 459  </div>
 460 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 461 _8c.html" target="source" name="SetPixelCacheVirtualMethod">SetPixelCacheVirtualMethod</a></h2>
 462 <div class="doc-section">
 463
 464 <p>SetPixelCacheVirtualMethod() sets the "virtual pixels" method for the pixel cache and returns the previous setting.  A virtual pixel is any pixel access that is outside the boundaries of the image cache.</p></ol>
 465
 466 <p>The format of the SetPixelCacheVirtualMethod() method is:</p>
 467
 468 <pre class="code">
 469   VirtualPixelMethod SetPixelCacheVirtualMethod(const Image *image,
 470     const VirtualPixelMethod virtual_pixel_method)
 471 </pre>
 472
 473 <p>A description of each parameter follows:</p></ol>
 474
 475 <h5>image</h5>
 476 <ol><p>the image.</p></ol>
 477
 478 <h5>virtual_pixel_method</h5>
 479 <ol><p>choose the type of virtual pixel.</p></ol>
 480
 481  </div>
 482 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 483 _8c.html" target="source" name="SyncAuthenticPixels">SyncAuthenticPixels</a></h2>
 484 <div class="doc-section">
 485
 486 <p>SyncAuthenticPixels() saves the image pixels to the in-memory or disk cache. The method returns MagickTrue if the pixel region is flushed, otherwise MagickFalse.</p></ol>
 487
 488 <p>The format of the SyncAuthenticPixels() method is:</p>
 489
 490 <pre class="code">
 491   MagickBooleanType SyncAuthenticPixels(Image *image,
 492     ExceptionInfo *exception)
 493 </pre>
 494
 495 <p>A description of each parameter follows:</p></ol>
 496
 497 <h5>image</h5>
 498 <ol><p>the image.</p></ol>
 499
 500 <h5>exception</h5>
 501 <ol><p>return any errors or warnings in this structure.</p></ol>
 502
 503  </div>
 504 \r
 505 </div>\r
 506 \r
 507 <div id="linkbar">\r
 508  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 509     <span id="linkbar-center">\r
 510       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 511       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 512     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 513     </span>\r
 514     <span id="linkbar-east">&nbsp;</span>\r
 515   </div>\r
 516   <div class="footer">\r
 517     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 518     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 519   </div>\r
 520   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 521 </body>\r
 522 </html>\r