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.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20090501000200 -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 133 </div>
 134 <div  class="sponsor">
 135    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 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="#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>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 157 _8c.html" target="source" name="AcquirePixelCacheNexus">AcquirePixelCacheNexus</a></h2>
 158 <div class="doc-section">
 159
 160 <p>AcquirePixelCacheNexus() allocates the NexusInfo structure.</p></ol>
 161
 162 <p>The format of the AcquirePixelCacheNexus method is:</p>
 163
 164 <pre class="code">
 165   NexusInfo **AcquirePixelCacheNexus(const unsigned long number_threads)
 166 </pre>
 167
 168 <p>A description of each parameter follows:</p></ol>
 169
 170 <h5>number_threads</h5>
 171 <ol><p>the number of nexus threads.</p></ol>
 172
 173  </div>
 174 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 175 _8c.html" target="source" name="GetAuthenticIndexQueue">GetAuthenticIndexQueue</a></h2>
 176 <div class="doc-section">
 177
 178 <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>
 179
 180 <p>The format of the GetAuthenticIndexQueue() method is:</p>
 181
 182 <pre class="code">
 183   IndexPacket *GetAuthenticIndexQueue(const Image *image)
 184 </pre>
 185
 186 <p>A description of each parameter follows:</p></ol>
 187
 188 <h5>image</h5>
 189 <ol><p>the image.</p></ol>
 190
 191  </div>
 192 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 193 _8c.html" target="source" name="GetAuthenticPixelQueue">GetAuthenticPixelQueue</a></h2>
 194 <div class="doc-section">
 195
 196 <p>GetAuthenticPixelQueue() returns the authentic pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().</p></ol>
 197
 198 <p>The format of the GetAuthenticPixelQueue() method is:</p>
 199
 200 <pre class="code">
 201   PixelPacket *GetAuthenticPixelQueue(const Image image)
 202 </pre>
 203
 204 <p>A description of each parameter follows:</p></ol>
 205
 206 <h5>image</h5>
 207 <ol><p>the image.</p></ol>
 208
 209  </div>
 210 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 211 _8c.html" target="source" name="GetAuthenticPixels">GetAuthenticPixels</a></h2>
 212 <div class="doc-section">
 213
 214 <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>
 215
 216 <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>
 217
 218 <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>
 219
 220 <p>The format of the GetAuthenticPixels() method is:</p>
 221
 222 <pre class="code">
 223   PixelPacket *GetAuthenticPixels(Image *image,const long x,const long y,
 224     const unsigned long columns,const unsigned long rows,
 225     ExceptionInfo *exception)
 226 </pre>
 227
 228 <p>A description of each parameter follows:</p></ol>
 229
 230 <h5>image</h5>
 231 <ol><p>the image.</p></ol>
 232
 233 <h5>x,y,columns,rows</h5>
 234 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 235
 236 <h5>exception</h5>
 237 <ol><p>return any errors or warnings in this structure.</p></ol>
 238
 239  </div>
 240 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 241 _8c.html" target="source" name="GetOneAuthenticPixel">GetOneAuthenticPixel</a></h2>
 242 <div class="doc-section">
 243
 244 <p>GetOneAuthenticPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.</p></ol>
 245
 246 <p>The format of the GetOneAuthenticPixel() method is:</p>
 247
 248 <pre class="code">
 249   MagickBooleanType GetOneAuthenticPixel(const Image image,const long x,
 250     const long y,PixelPacket *pixel,ExceptionInfo *exception)
 251 </pre>
 252
 253 <p>A description of each parameter follows:</p></ol>
 254
 255 <h5>image</h5>
 256 <ol><p>the image.</p></ol>
 257
 258 <h5>x,y</h5>
 259 <ol><p>These values define the location of the pixel to return.</p></ol>
 260
 261 <h5>pixel</h5>
 262 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 263
 264 <h5>exception</h5>
 265 <ol><p>return any errors or warnings in this structure.</p></ol>
 266
 267  </div>
 268 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 269 _8c.html" target="source" name="GetOneVirtualMagickPixel">GetOneVirtualMagickPixel</a></h2>
 270 <div class="doc-section">
 271
 272 <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>
 273
 274 <p>The format of the GetOneVirtualMagickPixel() method is:</p>
 275
 276 <pre class="code">
 277   MagickBooleanType GetOneVirtualMagickPixel(const Image image,
 278     const long x,const long y,MagickPixelPacket *pixel,
 279     ExceptionInfo exception)
 280 </pre>
 281
 282 <p>A description of each parameter follows:</p></ol>
 283
 284 <h5>image</h5>
 285 <ol><p>the image.</p></ol>
 286
 287 <h5>x,y</h5>
 288 <ol><p>these values define the location of the pixel to return.</p></ol>
 289
 290 <h5>pixel</h5>
 291 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 292
 293 <h5>exception</h5>
 294 <ol><p>return any errors or warnings in this structure.</p></ol>
 295
 296  </div>
 297 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 298 _8c.html" target="source" name="GetOneVirtualMethodPixel">GetOneVirtualMethodPixel</a></h2>
 299 <div class="doc-section">
 300
 301 <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>
 302
 303 <p>The format of the GetOneVirtualMethodPixel() method is:</p>
 304
 305 <pre class="code">
 306   MagickBooleanType GetOneVirtualMethodPixel(const Image image,
 307     const VirtualPixelMethod virtual_pixel_method,const long x,
 308     const long y,Pixelpacket *pixel,ExceptionInfo exception)
 309 </pre>
 310
 311 <p>A description of each parameter follows:</p></ol>
 312
 313 <h5>image</h5>
 314 <ol><p>the image.</p></ol>
 315
 316 <h5>virtual_pixel_method</h5>
 317 <ol><p>the virtual pixel method.</p></ol>
 318
 319 <h5>x,y</h5>
 320 <ol><p>These values define the location of the pixel to return.</p></ol>
 321
 322 <h5>pixel</h5>
 323 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 324
 325 <h5>exception</h5>
 326 <ol><p>return any errors or warnings in this structure.</p></ol>
 327
 328  </div>
 329 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 330 _8c.html" target="source" name="GetOneVirtualPixel">GetOneVirtualPixel</a></h2>
 331 <div class="doc-section">
 332
 333 <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>
 334
 335 <p>The format of the GetOneVirtualPixel() method is:</p>
 336
 337 <pre class="code">
 338   MagickBooleanType GetOneVirtualPixel(const Image image,const long x,
 339     const long y,PixelPacket *pixel,ExceptionInfo exception)
 340 </pre>
 341
 342 <p>A description of each parameter follows:</p></ol>
 343
 344 <h5>image</h5>
 345 <ol><p>the image.</p></ol>
 346
 347 <h5>x,y</h5>
 348 <ol><p>These values define the location of the pixel to return.</p></ol>
 349
 350 <h5>pixel</h5>
 351 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 352
 353 <h5>exception</h5>
 354 <ol><p>return any errors or warnings in this structure.</p></ol>
 355
 356  </div>
 357 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 358 _8c.html" target="source" name="GetVirtualIndexQueue">GetVirtualIndexQueue</a></h2>
 359 <div class="doc-section">
 360
 361 <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>
 362
 363 <p>The format of the GetVirtualIndexQueue() method is:</p>
 364
 365 <pre class="code">
 366   const IndexPacket *GetVirtualIndexQueue(const Image *image)
 367 </pre>
 368
 369 <p>A description of each parameter follows:</p></ol>
 370
 371 <h5>image</h5>
 372 <ol><p>the image.</p></ol>
 373
 374  </div>
 375 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 376 _8c.html" target="source" name="VirtualPixelModulo">VirtualPixelModulo</a></h2>
 377 <div class="doc-section">
 378
 379 <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>
 380  </div>
 381 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 382 _8c.html" target="source" name="GetVirtualPixelQueue">GetVirtualPixelQueue</a></h2>
 383 <div class="doc-section">
 384
 385 <p>GetVirtualPixelQueue() returns the virtual pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().</p></ol>
 386
 387 <p>The format of the GetVirtualPixelQueue() method is:</p>
 388
 389 <pre class="code">
 390   const PixelPacket *GetVirtualPixelQueue(const Image image)
 391 </pre>
 392
 393 <p>A description of each parameter follows:</p></ol>
 394
 395 <h5>image</h5>
 396 <ol><p>the image.</p></ol>
 397
 398  </div>
 399 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 400 _8c.html" target="source" name="GetVirtualPixels">GetVirtualPixels</a></h2>
 401 <div class="doc-section">
 402
 403 <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>
 404
 405 <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>
 406
 407 <p>If you plan to modify the pixels, use GetAuthenticPixels() instead.</p></ol>
 408
 409 <p>Note, the GetVirtualPixels() and GetAuthenticPixels() methods are not thread- safe.  In a threaded environment, use GetCacheViewVirtualPixels() or GetCacheViewAuthenticPixels() instead.</p></ol>
 410
 411 <p>The format of the GetVirtualPixels() method is:</p>
 412
 413 <pre class="code">
 414   const PixelPacket *GetVirtualPixels(const Image *image,const long x,
 415     const long y,const unsigned long columns,const unsigned long rows,
 416     ExceptionInfo *exception)
 417 </pre>
 418
 419 <p>A description of each parameter follows:</p></ol>
 420
 421 <h5>image</h5>
 422 <ol><p>the image.</p></ol>
 423
 424 <h5>x,y,columns,rows</h5>
 425 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 426
 427 <h5>exception</h5>
 428 <ol><p>return any errors or warnings in this structure.</p></ol>
 429
 430  </div>
 431 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 432 _8c.html" target="source" name="QueueAuthenticPixels">QueueAuthenticPixels</a></h2>
 433 <div class="doc-section">
 434
 435 <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>
 436
 437 <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>
 438
 439 <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>
 440
 441 <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>
 442
 443 <p>The format of the QueueAuthenticPixels() method is:</p>
 444
 445 <pre class="code">
 446   PixelPacket *QueueAuthenticPixels(Image *image,const long x,const long y,
 447     const unsigned long columns,const unsigned long rows,
 448     ExceptionInfo *exception)
 449 </pre>
 450
 451 <p>A description of each parameter follows:</p></ol>
 452
 453 <h5>image</h5>
 454 <ol><p>the image.</p></ol>
 455
 456 <h5>x,y,columns,rows</h5>
 457 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 458
 459 <h5>exception</h5>
 460 <ol><p>return any errors or warnings in this structure.</p></ol>
 461
 462  </div>
 463 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 464 _8c.html" target="source" name="SetPixelCacheVirtualMethod">SetPixelCacheVirtualMethod</a></h2>
 465 <div class="doc-section">
 466
 467 <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>
 468
 469 <p>The format of the SetPixelCacheVirtualMethod() method is:</p>
 470
 471 <pre class="code">
 472   VirtualPixelMethod SetPixelCacheVirtualMethod(const Image *image,
 473     const VirtualPixelMethod virtual_pixel_method)
 474 </pre>
 475
 476 <p>A description of each parameter follows:</p></ol>
 477
 478 <h5>image</h5>
 479 <ol><p>the image.</p></ol>
 480
 481 <h5>virtual_pixel_method</h5>
 482 <ol><p>choose the type of virtual pixel.</p></ol>
 483
 484  </div>
 485 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache
 486 _8c.html" target="source" name="SyncAuthenticPixels">SyncAuthenticPixels</a></h2>
 487 <div class="doc-section">
 488
 489 <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>
 490
 491 <p>The format of the SyncAuthenticPixels() method is:</p>
 492
 493 <pre class="code">
 494   MagickBooleanType SyncAuthenticPixels(Image *image,
 495     ExceptionInfo *exception)
 496 </pre>
 497
 498 <p>A description of each parameter follows:</p></ol>
 499
 500 <h5>image</h5>
 501 <ol><p>the image.</p></ol>
 502
 503 <h5>exception</h5>
 504 <ol><p>return any errors or warnings in this structure.</p></ol>
 505
 506  </div>
 507 \r
 508 </div>\r
 509 \r
 510 <div id="linkbar">\r
 511  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 512     <span id="linkbar-center">\r
 513       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 514       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 515     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 516     </span>\r
 517     <span id="linkbar-east">&nbsp;</span>\r
 518   </div>\r
 519   <div class="footer">\r
 520     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 521     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 522   </div>\r
 523   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 524 </body>\r
 525 </html>\r