granicus.if.org Git - imagemagick/blob - www/api/cache-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: MagickCore, C API for ImageMagick: Cache Views</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:, cache, views, 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.print24.de/">Druckerei</a><!-- 201009010720 -->
 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.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="#AcquireCacheView">AcquireCacheView</a> &bull; <a href="#CloneCacheView">CloneCacheView</a> &bull; <a href="#DestroyCacheView">DestroyCacheView</a> &bull; <a href="#GetCacheViewColorspace">GetCacheViewColorspace</a> &bull; <a href="#GetCacheViewException">GetCacheViewException</a> &bull; <a href="#GetCacheViewStorageClass">GetCacheViewStorageClass</a> &bull; <a href="#GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a> &bull; <a href="#GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a> &bull; <a href="#GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a> &bull; <a href="#GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a> &bull; <a href="#GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a> &bull; <a href="#GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a> &bull; <a href="#GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a> &bull; <a href="#GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a> &bull; <a href="#GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a> &bull; <a href="#QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a> &bull; <a href="#SetCacheViewStorageClass">SetCacheViewStorageClass</a> &bull; <a href="#SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a> &bull; <a href="#SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a>]</p>
 152
 153 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 154 _8c.html" target="source" name="AcquireCacheView">AcquireCacheView</a></h2>
 155 <div class="doc-section">
 156
 157 <p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
 158
 159 <p>The format of the AcquireCacheView method is:</p>
 160
 161 <pre class="code">
 162   CacheView *AcquireCacheView(const Image *image)
 163 </pre>
 164
 165 <p>A description of each parameter follows:</p></ol>
 166
 167 <h5>image</h5>
 168 <ol><p>the image.</p></ol>
 169
 170  </div>
 171 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 172 _8c.html" target="source" name="CloneCacheView">CloneCacheView</a></h2>
 173 <div class="doc-section">
 174
 175 <p>CloneCacheView()  makes an exact copy of the specified cache view.</p></ol>
 176
 177 <p>The format of the CloneCacheView method is:</p>
 178
 179 <pre class="code">
 180   CacheView *CloneCacheView(const CacheView *cache_view)
 181 </pre>
 182
 183 <p>A description of each parameter follows:</p></ol>
 184
 185 <h5>cache_view</h5>
 186 <ol><p>the cache view.</p></ol>
 187
 188  </div>
 189 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 190 _8c.html" target="source" name="DestroyCacheView">DestroyCacheView</a></h2>
 191 <div class="doc-section">
 192
 193 <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p></ol>
 194
 195 <p>The format of the DestroyCacheView method is:</p>
 196
 197 <pre class="code">
 198   CacheView *DestroyCacheView(CacheView *cache_view)
 199 </pre>
 200
 201 <p>A description of each parameter follows:</p></ol>
 202
 203 <h5>cache_view</h5>
 204 <ol><p>the cache view.</p></ol>
 205
 206  </div>
 207 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 208 _8c.html" target="source" name="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
 209 <div class="doc-section">
 210
 211 <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p></ol>
 212
 213 <p>The format of the GetCacheViewColorspace method is:</p>
 214
 215 <pre class="code">
 216   ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
 217 </pre>
 218
 219 <p>A description of each parameter follows:</p></ol>
 220
 221 <h5>cache_view</h5>
 222 <ol><p>the cache view.</p></ol>
 223
 224  </div>
 225 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 226 _8c.html" target="source" name="GetCacheViewException">GetCacheViewException</a></h2>
 227 <div class="doc-section">
 228
 229 <p>GetCacheViewException() returns the image exception associated with the specified view.</p></ol>
 230
 231 <p>The format of the GetCacheViewException method is:</p>
 232
 233 <pre class="code">
 234   ExceptionInfo GetCacheViewException(const CacheView *cache_view)
 235 </pre>
 236
 237 <p>A description of each parameter follows:</p></ol>
 238
 239 <h5>cache_view</h5>
 240 <ol><p>the cache view.</p></ol>
 241
 242  </div>
 243 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 244 _8c.html" target="source" name="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
 245 <div class="doc-section">
 246
 247 <p>GetCacheViewStorageClass() returns the image storage class  associated with the specified view.</p></ol>
 248
 249 <p>The format of the GetCacheViewStorageClass method is:</p>
 250
 251 <pre class="code">
 252   ClassType GetCacheViewStorageClass(const CacheView *cache_view)
 253 </pre>
 254
 255 <p>A description of each parameter follows:</p></ol>
 256
 257 <h5>cache_view</h5>
 258 <ol><p>the cache view.</p></ol>
 259
 260  </div>
 261 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 262 _8c.html" target="source" name="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
 263 <div class="doc-section">
 264
 265 <p>GetCacheViewAuthenticPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters.   A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
 266
 267 <p>The format of the GetCacheViewAuthenticPixels method is:</p>
 268
 269 <pre class="code">
 270   PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
 271     const long x,const long y,const unsigned long columns,
 272     const unsigned long rows,ExceptionInfo *exception)
 273 </pre>
 274
 275 <p>A description of each parameter follows:</p></ol>
 276
 277 <h5>cache_view</h5>
 278 <ol><p>the cache view.</p></ol>
 279
 280 <h5>x,y,columns,rows</h5>
 281 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 282
 283  </div>
 284 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 285 _8c.html" target="source" name="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
 286 <div class="doc-section">
 287
 288 <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.</p></ol>
 289
 290 <p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
 291
 292 <pre class="code">
 293   MagickBooleaNType GetOneCacheViewAuthenticPixel(
 294     const CacheView *cache_view,const long x,const long y,
 295     Pixelpacket *pixel,ExceptionInfo *exception)
 296 </pre>
 297
 298 <p>A description of each parameter follows:</p></ol>
 299
 300 <h5>cache_view</h5>
 301 <ol><p>the cache view.</p></ol>
 302
 303 <h5>x,y</h5>
 304 <ol><p>These values define the offset of the pixel.</p></ol>
 305
 306 <h5>pixel</h5>
 307 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 308
 309 <h5>exception</h5>
 310 <ol><p>return any errors or warnings in this structure.</p></ol>
 311
 312  </div>
 313 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 314 _8c.html" target="source" name="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
 315 <div class="doc-section">
 316
 317 <p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue().  The indexes are authentic and can be updated.</p></ol>
 318
 319 <p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
 320
 321 <pre class="code">
 322   IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
 323 </pre>
 324
 325 <p>A description of each parameter follows:</p></ol>
 326
 327 <h5>cache_view</h5>
 328 <ol><p>the cache view.</p></ol>
 329
 330  </div>
 331 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 332 _8c.html" target="source" name="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
 333 <div class="doc-section">
 334
 335 <p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels().  The pixels are authentic and therefore can be updated.</p></ol>
 336
 337 <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
 338
 339 <pre class="code">
 340   PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
 341 </pre>
 342
 343 <p>A description of each parameter follows:</p></ol>
 344
 345 <h5>cache_view</h5>
 346 <ol><p>the cache view.</p></ol>
 347
 348  </div>
 349 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 350 _8c.html" target="source" name="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
 351 <div class="doc-section">
 352
 353 <p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue().  The indexes are virtual and therefore cannot be updated.</p></ol>
 354
 355 <p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
 356
 357 <pre class="code">
 358   const IndexPacket *GetCacheViewVirtualIndexQueue(
 359     const CacheView *cache_view)
 360 </pre>
 361
 362 <p>A description of each parameter follows:</p></ol>
 363
 364 <h5>cache_view</h5>
 365 <ol><p>the cache view.</p></ol>
 366
 367  </div>
 368 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 369 _8c.html" target="source" name="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
 370 <div class="doc-section">
 371
 372 <p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels().  The pixels are virtual and therefore cannot be updated.</p></ol>
 373
 374 <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
 375
 376 <pre class="code">
 377   const PixelPacket *GetCacheViewVirtualPixelQueue(
 378     const CacheView *cache_view)
 379 </pre>
 380
 381 <p>A description of each parameter follows:</p></ol>
 382
 383 <h5>cache_view</h5>
 384 <ol><p>the cache view.</p></ol>
 385
 386  </div>
 387 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 388 _8c.html" target="source" name="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
 389 <div class="doc-section">
 390
 391 <p>GetCacheViewVirtualPixels() gets virtual pixels from the in-memory or disk pixel cache as defined by the geometry parameters.   A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
 392
 393 <p>The format of the GetCacheViewVirtualPixels method is:</p>
 394
 395 <pre class="code">
 396   const PixelPacket *GetCacheViewVirtualPixels(
 397     const CacheView *cache_view,const long x,const long y,
 398     const unsigned long columns,const unsigned long rows,
 399     ExceptionInfo *exception)
 400 </pre>
 401
 402 <p>A description of each parameter follows:</p></ol>
 403
 404 <h5>cache_view</h5>
 405 <ol><p>the cache view.</p></ol>
 406
 407 <h5>x,y,columns,rows</h5>
 408 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 409
 410 <h5>exception</h5>
 411 <ol><p>return any errors or warnings in this structure.</p></ol>
 412
 413  </div>
 414 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 415 _8c.html" target="source" name="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
 416 <div class="doc-section">
 417
 418 <p>GetOneCacheViewVirtualPixel() 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 GetOneCacheViewAuthenticPixel() instead.</p></ol>
 419
 420 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 421
 422 <pre class="code">
 423   MagickBooleanType GetOneCacheViewVirtualPixel(
 424     const CacheView *cache_view,const long x,const long y,
 425     PixelPacket *pixel,ExceptionInfo *exception)
 426 </pre>
 427
 428 <p>A description of each parameter follows:</p></ol>
 429
 430 <h5>cache_view</h5>
 431 <ol><p>the cache view.</p></ol>
 432
 433 <h5>x,y</h5>
 434 <ol><p>These values define the offset of the pixel.</p></ol>
 435
 436 <h5>pixel</h5>
 437 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 438
 439 <h5>exception</h5>
 440 <ol><p>return any errors or warnings in this structure.</p></ol>
 441
 442  </div>
 443 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 444 _8c.html" target="source" name="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
 445 <div class="doc-section">
 446
 447 <p>GetOneCacheViewVirtualMethodPixel() 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 GetOneCacheViewAuthenticPixel() instead.</p></ol>
 448
 449 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 450
 451 <pre class="code">
 452   MagickBooleanType GetOneCacheViewVirtualMethodPixel(
 453     const CacheView *cache_view,
 454     const VirtualPixelMethod virtual_pixel_method,const long x,
 455     const long y,PixelPacket *pixel,ExceptionInfo *exception)
 456 </pre>
 457
 458 <p>A description of each parameter follows:</p></ol>
 459
 460 <h5>cache_view</h5>
 461 <ol><p>the cache view.</p></ol>
 462
 463 <h5>virtual_pixel_method</h5>
 464 <ol><p>the virtual pixel method.</p></ol>
 465
 466 <h5>x,y</h5>
 467 <ol><p>These values define the offset of the pixel.</p></ol>
 468
 469 <h5>pixel</h5>
 470 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 471
 472 <h5>exception</h5>
 473 <ol><p>return any errors or warnings in this structure.</p></ol>
 474
 475  </div>
 476 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 477 _8c.html" target="source" name="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
 478 <div class="doc-section">
 479
 480 <p>QueueCacheViewAuthenticPixels() queues authentic pixels from the in-memory or disk pixel cache as defined by the geometry parameters.   A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
 481
 482 <p>The format of the QueueCacheViewAuthenticPixels method is:</p>
 483
 484 <pre class="code">
 485   PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
 486     const long x,const long y,const unsigned long columns,
 487     const unsigned long rows,ExceptionInfo *exception)
 488 </pre>
 489
 490 <p>A description of each parameter follows:</p></ol>
 491
 492 <h5>cache_view</h5>
 493 <ol><p>the cache view.</p></ol>
 494
 495 <h5>x,y,columns,rows</h5>
 496 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 497
 498 <h5>exception</h5>
 499 <ol><p>return any errors or warnings in this structure.</p></ol>
 500
 501  </div>
 502 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 503 _8c.html" target="source" name="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
 504 <div class="doc-section">
 505
 506 <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p></ol>
 507
 508 <p>The format of the SetCacheViewStorageClass method is:</p>
 509
 510 <pre class="code">
 511   MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
 512     const ClassType storage_class)
 513 </pre>
 514
 515 <p>A description of each parameter follows:</p></ol>
 516
 517 <h5>cache_view</h5>
 518 <ol><p>the cache view.</p></ol>
 519
 520 <h5>storage_class</h5>
 521 <ol><p>the image storage class: PseudoClass or DirectClass.</p></ol>
 522
 523  </div>
 524 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 525 _8c.html" target="source" name="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
 526 <div class="doc-section">
 527
 528 <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p></ol>
 529
 530 <p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
 531
 532 <pre class="code">
 533   MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
 534     const VirtualPixelMethod virtual_pixel_method)
 535 </pre>
 536
 537 <p>A description of each parameter follows:</p></ol>
 538
 539 <h5>cache_view</h5>
 540 <ol><p>the cache view.</p></ol>
 541
 542 <h5>virtual_pixel_method</h5>
 543 <ol><p>the virtual pixel method.</p></ol>
 544
 545  </div>
 546 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 547 _8c.html" target="source" name="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
 548 <div class="doc-section">
 549
 550 <p>SyncCacheViewAuthenticPixels() saves the cache view pixels to the in-memory or disk cache.  It returns MagickTrue if the pixel region is flushed, otherwise MagickFalse.</p></ol>
 551
 552 <p>The format of the SyncCacheViewAuthenticPixels method is:</p>
 553
 554 <pre class="code">
 555   MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
 556     ExceptionInfo *exception)
 557 </pre>
 558
 559 <p>A description of each parameter follows:</p></ol>
 560
 561 <h5>cache_view</h5>
 562 <ol><p>the cache view.</p></ol>
 563
 564 <h5>exception</h5>
 565 <ol><p>return any errors or warnings in this structure.</p></ol>
 566
 567  </div>
 568 \r
 569 </div>\r
 570 \r
 571 <div id="linkbar">\r
 572  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 573     <span id="linkbar-center">\r
 574       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 575       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 576     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 577     </span>\r
 578     <span id="linkbar-east">&nbsp;</span>\r
 579   </div>\r
 580   <div class="footer">\r
 581     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 582     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 583   </div>\r
 584   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 585 </body>\r
 586 </html>\r