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