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 http-equiv="Content-Type" value="application/xhtml+xml" />\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   7   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   8   <style type="text/css" media="screen,projection"><!--\r
   9     @import url("../../www/magick.css");\r
  10   --></style>\r
  11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  12   <title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title>
  13   <meta http-equiv="Content-Language" content="en-US"/>
  14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="Generator" content="PHP"/>
  17   <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"/>
  18   <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."/>
  19   <meta name="Rating" content="GENERAL"/>
  20   <meta name="Robots" content="INDEX, FOLLOW"/>
  21   <meta name="Generator" content="ImageMagick Studio LLC"/>
  22   <meta name="Author" content="ImageMagick Studio LLC"/>
  23   <meta name="Revisit-after" content="2 DAYS"/>
  24   <meta name="Resource-type" content="document"/>
  25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  26   <meta name="Distribution" content="Global"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../../index.html">\r
  32   <img src="../../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../../index.html">\r
  41   <img src="../../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="eastbar">\r
  46 \r
  47 <div class="menu">
  48   <a href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
 128 </div>
 129 <div  class="sponsor">
 130   <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 134 </div>
 135 <div  class="sponsor">
 136   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 140 </div>
 141 <div  class="sponsor">
 142   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 143 </div>
 144 <div  class="sponsor">
 145    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 146 </div>
 147 <div  class="sponsor">
 148    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 149 </div>
 150 </div>
 151 </div>
 152 \r
 153 \r
 154 </div>\r
 155 \r
 156 <div class="main">\r
 157 \r
 158 <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>
 159
 160 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 161 _8c.html" target="source" name="AcquireCacheView">AcquireCacheView</a></h2>
 162 <div class="doc-section">
 163
 164 <p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
 165
 166 <p>The format of the AcquireCacheView method is:</p>
 167
 168 <pre class="code">
 169   CacheView *AcquireCacheView(const Image *image)
 170 </pre>
 171
 172 <p>A description of each parameter follows:</p></ol>
 173
 174 <h5>image</h5>
 175 <ol><p>the image.</p></ol>
 176
 177  </div>
 178 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 179 _8c.html" target="source" name="CloneCacheView">CloneCacheView</a></h2>
 180 <div class="doc-section">
 181
 182 <p>CloneCacheView()  makes an exact copy of the specified cache view.</p></ol>
 183
 184 <p>The format of the CloneCacheView method is:</p>
 185
 186 <pre class="code">
 187   CacheView *CloneCacheView(const CacheView *cache_view)
 188 </pre>
 189
 190 <p>A description of each parameter follows:</p></ol>
 191
 192 <h5>cache_view</h5>
 193 <ol><p>the cache view.</p></ol>
 194
 195  </div>
 196 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 197 _8c.html" target="source" name="DestroyCacheView">DestroyCacheView</a></h2>
 198 <div class="doc-section">
 199
 200 <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p></ol>
 201
 202 <p>The format of the DestroyCacheView method is:</p>
 203
 204 <pre class="code">
 205   CacheView *DestroyCacheView(CacheView *cache_view)
 206 </pre>
 207
 208 <p>A description of each parameter follows:</p></ol>
 209
 210 <h5>cache_view</h5>
 211 <ol><p>the cache view.</p></ol>
 212
 213  </div>
 214 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 215 _8c.html" target="source" name="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
 216 <div class="doc-section">
 217
 218 <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p></ol>
 219
 220 <p>The format of the GetCacheViewColorspace method is:</p>
 221
 222 <pre class="code">
 223   ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
 224 </pre>
 225
 226 <p>A description of each parameter follows:</p></ol>
 227
 228 <h5>cache_view</h5>
 229 <ol><p>the cache view.</p></ol>
 230
 231  </div>
 232 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 233 _8c.html" target="source" name="GetCacheViewException">GetCacheViewException</a></h2>
 234 <div class="doc-section">
 235
 236 <p>GetCacheViewException() returns the image exception associated with the specified view.</p></ol>
 237
 238 <p>The format of the GetCacheViewException method is:</p>
 239
 240 <pre class="code">
 241   ExceptionInfo GetCacheViewException(const CacheView *cache_view)
 242 </pre>
 243
 244 <p>A description of each parameter follows:</p></ol>
 245
 246 <h5>cache_view</h5>
 247 <ol><p>the cache view.</p></ol>
 248
 249  </div>
 250 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 251 _8c.html" target="source" name="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
 252 <div class="doc-section">
 253
 254 <p>GetCacheViewStorageClass() returns the image storage class  associated with the specified view.</p></ol>
 255
 256 <p>The format of the GetCacheViewStorageClass method is:</p>
 257
 258 <pre class="code">
 259   ClassType GetCacheViewStorageClass(const CacheView *cache_view)
 260 </pre>
 261
 262 <p>A description of each parameter follows:</p></ol>
 263
 264 <h5>cache_view</h5>
 265 <ol><p>the cache view.</p></ol>
 266
 267  </div>
 268 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 269 _8c.html" target="source" name="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
 270 <div class="doc-section">
 271
 272 <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>
 273
 274 <p>The format of the GetCacheViewAuthenticPixels method is:</p>
 275
 276 <pre class="code">
 277   PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
 278     const long x,const long y,const unsigned long columns,
 279     const unsigned long rows,ExceptionInfo *exception)
 280 </pre>
 281
 282 <p>A description of each parameter follows:</p></ol>
 283
 284 <h5>cache_view</h5>
 285 <ol><p>the cache view.</p></ol>
 286
 287 <h5>x,y,columns,rows</h5>
 288 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 289
 290  </div>
 291 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 292 _8c.html" target="source" name="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
 293 <div class="doc-section">
 294
 295 <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.</p></ol>
 296
 297 <p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
 298
 299 <pre class="code">
 300   MagickBooleaNType GetOneCacheViewAuthenticPixel(
 301     const CacheView *cache_view,const long x,const long y,
 302     Pixelpacket *pixel,ExceptionInfo *exception)
 303 </pre>
 304
 305 <p>A description of each parameter follows:</p></ol>
 306
 307 <h5>cache_view</h5>
 308 <ol><p>the cache view.</p></ol>
 309
 310 <h5>x,y</h5>
 311 <ol><p>These values define the offset of the pixel.</p></ol>
 312
 313 <h5>pixel</h5>
 314 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 315
 316 <h5>exception</h5>
 317 <ol><p>return any errors or warnings in this structure.</p></ol>
 318
 319  </div>
 320 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 321 _8c.html" target="source" name="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
 322 <div class="doc-section">
 323
 324 <p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue().  The indexes are authentic and can be updated.</p></ol>
 325
 326 <p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
 327
 328 <pre class="code">
 329   IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
 330 </pre>
 331
 332 <p>A description of each parameter follows:</p></ol>
 333
 334 <h5>cache_view</h5>
 335 <ol><p>the cache view.</p></ol>
 336
 337  </div>
 338 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 339 _8c.html" target="source" name="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
 340 <div class="doc-section">
 341
 342 <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>
 343
 344 <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
 345
 346 <pre class="code">
 347   PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
 348 </pre>
 349
 350 <p>A description of each parameter follows:</p></ol>
 351
 352 <h5>cache_view</h5>
 353 <ol><p>the cache view.</p></ol>
 354
 355  </div>
 356 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 357 _8c.html" target="source" name="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
 358 <div class="doc-section">
 359
 360 <p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue().  The indexes are virtual and therefore cannot be updated.</p></ol>
 361
 362 <p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
 363
 364 <pre class="code">
 365   const IndexPacket *GetCacheViewVirtualIndexQueue(
 366     const CacheView *cache_view)
 367 </pre>
 368
 369 <p>A description of each parameter follows:</p></ol>
 370
 371 <h5>cache_view</h5>
 372 <ol><p>the cache view.</p></ol>
 373
 374  </div>
 375 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 376 _8c.html" target="source" name="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
 377 <div class="doc-section">
 378
 379 <p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels().  The pixels are virtual and therefore cannot be updated.</p></ol>
 380
 381 <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
 382
 383 <pre class="code">
 384   const PixelPacket *GetCacheViewVirtualPixelQueue(
 385     const CacheView *cache_view)
 386 </pre>
 387
 388 <p>A description of each parameter follows:</p></ol>
 389
 390 <h5>cache_view</h5>
 391 <ol><p>the cache view.</p></ol>
 392
 393  </div>
 394 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 395 _8c.html" target="source" name="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
 396 <div class="doc-section">
 397
 398 <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>
 399
 400 <p>The format of the GetCacheViewVirtualPixels method is:</p>
 401
 402 <pre class="code">
 403   const PixelPacket *GetCacheViewVirtualPixels(
 404     const CacheView *cache_view,const long x,const long y,
 405     const unsigned long columns,const unsigned long rows,
 406     ExceptionInfo *exception)
 407 </pre>
 408
 409 <p>A description of each parameter follows:</p></ol>
 410
 411 <h5>cache_view</h5>
 412 <ol><p>the cache view.</p></ol>
 413
 414 <h5>x,y,columns,rows</h5>
 415 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 416
 417 <h5>exception</h5>
 418 <ol><p>return any errors or warnings in this structure.</p></ol>
 419
 420  </div>
 421 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 422 _8c.html" target="source" name="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
 423 <div class="doc-section">
 424
 425 <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>
 426
 427 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 428
 429 <pre class="code">
 430   MagickBooleanType GetOneCacheViewVirtualPixel(
 431     const CacheView *cache_view,const long x,const long y,
 432     PixelPacket *pixel,ExceptionInfo *exception)
 433 </pre>
 434
 435 <p>A description of each parameter follows:</p></ol>
 436
 437 <h5>cache_view</h5>
 438 <ol><p>the cache view.</p></ol>
 439
 440 <h5>x,y</h5>
 441 <ol><p>These values define the offset of the pixel.</p></ol>
 442
 443 <h5>pixel</h5>
 444 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 445
 446 <h5>exception</h5>
 447 <ol><p>return any errors or warnings in this structure.</p></ol>
 448
 449  </div>
 450 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 451 _8c.html" target="source" name="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
 452 <div class="doc-section">
 453
 454 <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>
 455
 456 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 457
 458 <pre class="code">
 459   MagickBooleanType GetOneCacheViewVirtualMethodPixel(
 460     const CacheView *cache_view,
 461     const VirtualPixelMethod virtual_pixel_method,const long x,
 462     const long y,PixelPacket *pixel,ExceptionInfo *exception)
 463 </pre>
 464
 465 <p>A description of each parameter follows:</p></ol>
 466
 467 <h5>cache_view</h5>
 468 <ol><p>the cache view.</p></ol>
 469
 470 <h5>virtual_pixel_method</h5>
 471 <ol><p>the virtual pixel method.</p></ol>
 472
 473 <h5>x,y</h5>
 474 <ol><p>These values define the offset of the pixel.</p></ol>
 475
 476 <h5>pixel</h5>
 477 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 478
 479 <h5>exception</h5>
 480 <ol><p>return any errors or warnings in this structure.</p></ol>
 481
 482  </div>
 483 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 484 _8c.html" target="source" name="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
 485 <div class="doc-section">
 486
 487 <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>
 488
 489 <p>The format of the QueueCacheViewAuthenticPixels method is:</p>
 490
 491 <pre class="code">
 492   PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
 493     const long x,const long y,const unsigned long columns,
 494     const unsigned long rows,ExceptionInfo *exception)
 495 </pre>
 496
 497 <p>A description of each parameter follows:</p></ol>
 498
 499 <h5>cache_view</h5>
 500 <ol><p>the cache view.</p></ol>
 501
 502 <h5>x,y,columns,rows</h5>
 503 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 504
 505 <h5>exception</h5>
 506 <ol><p>return any errors or warnings in this structure.</p></ol>
 507
 508  </div>
 509 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 510 _8c.html" target="source" name="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
 511 <div class="doc-section">
 512
 513 <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p></ol>
 514
 515 <p>The format of the SetCacheViewStorageClass method is:</p>
 516
 517 <pre class="code">
 518   MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
 519     const ClassType storage_class)
 520 </pre>
 521
 522 <p>A description of each parameter follows:</p></ol>
 523
 524 <h5>cache_view</h5>
 525 <ol><p>the cache view.</p></ol>
 526
 527 <h5>storage_class</h5>
 528 <ol><p>the image storage class: PseudoClass or DirectClass.</p></ol>
 529
 530  </div>
 531 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 532 _8c.html" target="source" name="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
 533 <div class="doc-section">
 534
 535 <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p></ol>
 536
 537 <p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
 538
 539 <pre class="code">
 540   MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
 541     const VirtualPixelMethod virtual_pixel_method)
 542 </pre>
 543
 544 <p>A description of each parameter follows:</p></ol>
 545
 546 <h5>cache_view</h5>
 547 <ol><p>the cache view.</p></ol>
 548
 549 <h5>virtual_pixel_method</h5>
 550 <ol><p>the virtual pixel method.</p></ol>
 551
 552  </div>
 553 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 554 _8c.html" target="source" name="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
 555 <div class="doc-section">
 556
 557 <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>
 558
 559 <p>The format of the SyncCacheViewAuthenticPixels method is:</p>
 560
 561 <pre class="code">
 562   MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
 563     ExceptionInfo *exception)
 564 </pre>
 565
 566 <p>A description of each parameter follows:</p></ol>
 567
 568 <h5>cache_view</h5>
 569 <ol><p>the cache view.</p></ol>
 570
 571 <h5>exception</h5>
 572 <ol><p>return any errors or warnings in this structure.</p></ol>
 573
 574  </div>
 575 \r
 576 </div>\r
 577 \r
 578 <div id="linkbar">\r
 579  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 580     <span id="linkbar-center">\r
 581       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 582     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 583     </span>\r
 584     <span id="linkbar-east">&nbsp;</span>\r
 585   </div>\r
 586   <div class="footer">\r
 587     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 588     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 589   </div>\r
 590   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 591 </body>\r
 592 </html>\r