Home | History | Annotate | Download | only in api
      1 
      2 
      3 
      4 
      5 <!DOCTYPE html>
      6 <html lang="en">
      7 <head>
      8     <title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title>
      9   <meta charset="utf-8" />
     10   <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     11   <meta name="viewport" content="width=device-width, initial-scale=1" />
     12   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
     13   <meta name="application-name" content="ImageMagick"/>
     14   <meta name="description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bzier curves."/>
     15   <meta name="application-url" content="http://www.imagemagick.org"/>
     16   <meta name="generator" content="PHP"/>
     17   <meta name="keywords" content="magickcore, c, api, for, imagemagick:, cache, views, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"/>
     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-2016 ImageMagick Studio LLC"/>
     25   <meta name="distribution" content="Global"/>
     26   <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"/>
     27   <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
     28   <link rel="icon" href="../images/wand.png"/>
     29   <link rel="shortcut icon" href="../images/wand.ico"/>
     30   <link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Roboto:900,400,400italic,700,700italic,300,300italic|Open+Sans:300italic,400italic,700italic,300,400,600,700">
     31   <link rel="stylesheet" href="../css/magick.html"/>
     32 </head>
     33 <body>
     34 <div class="main">
     35 <div class="magick-masthead">
     36   <div class="container">
     37     <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script>    <ins class="adsbygoogle"
     38          style="display:block"
     39          data-ad-client="ca-pub-3129977114552745"
     40          data-ad-slot="6345125851"
     41          data-ad-format="auto"></ins>
     42     <script>
     43       (adsbygoogle = window.adsbygoogle || []).push({});
     44     </script>
     45     <nav class="magick-nav">
     46       <a class="magick-nav-item " href="../index.html">Home</a>
     47       <a class="magick-nav-item " href="../binary-releases.html">Download</a>
     48       <a class="magick-nav-item " href="../command-line-tools.html">Tools</a>
     49       <a class="magick-nav-item " href="../command-line-processing.html">Command-line</a>
     50       <a class="magick-nav-item " href="../resources.html">Resources</a>
     51       <a class="magick-nav-item " href="api.html">Develop</a>
     52       <a class="magick-nav-item " href="http://www.imagemagick.org/script/search.php">Search</a>
     53       <a class="magick-nav-item pull-right" href="https://www.imagemagick.org/discourse-server/">Community</a>
     54     </nav>
     55   </div>
     56 </div>
     57 <div class="container">
     58 <div class="magick-header">
     59 <p class="text-center"><a href="cache-view.html#AcquireAuthenticCacheView">AcquireAuthenticCacheView</a> &#8226; <a href="cache-view.html#AcquireVirtualCacheView">AcquireVirtualCacheView</a> &#8226; <a href="cache-view.html#CloneCacheView">CloneCacheView</a> &#8226; <a href="cache-view.html#DestroyCacheView">DestroyCacheView</a> &#8226; <a href="cache-view.html#GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a> &#8226; <a href="cache-view.html#GetCacheViewAuthenticMetacontent">GetCacheViewAuthenticMetacontent</a> &#8226; <a href="cache-view.html#GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a> &#8226; <a href="cache-view.html#GetCacheViewColorspace">GetCacheViewColorspace</a> &#8226; <a href="cache-view.html#GetCacheViewImage">GetCacheViewImage</a> &#8226; <a href="cache-view.html#GetCacheViewStorageClass">GetCacheViewStorageClass</a> &#8226; <a href="cache-view.html#GetCacheViewVirtualMetacontent">GetCacheViewVirtualMetacontent</a> &#8226; <a href="cache-view.html#GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a> &#8226; <a href="cache-view.html#GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a> &#8226; <a href="cache-view.html#GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a> &#8226; <a href="cache-view.html#GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a> &#8226; <a href="cache-view.html#GetOneCacheViewVirtualPixelInfo">GetOneCacheViewVirtualPixelInfo</a> &#8226; <a href="cache-view.html#GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a> &#8226; <a href="cache-view.html#QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a> &#8226; <a href="cache-view.html#SetCacheViewStorageClass">SetCacheViewStorageClass</a> &#8226; <a href="cache-view.html#SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a> &#8226; <a href="cache-view.html#SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></p>
     60 
     61 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireAuthenticCacheView">AcquireAuthenticCacheView</a></h2>
     62 
     63 <p>AcquireAuthenticCacheView() acquires an authentic view into the pixel cache. It always succeeds but may return a warning or informational exception.</p>
     64 
     65 <p>The format of the AcquireAuthenticCacheView method is:</p>
     66 
     67 <pre class="text">
     68 CacheView *AcquireAuthenticCacheView(const Image *image,
     69   ExceptionInfo *exception)
     70 </pre>
     71 
     72 <p>A description of each parameter follows:</p>
     73 
     74 <dd>
     75 </dd>
     76 
     77 <dd> </dd>
     78 <dl class="dl-horizontal">
     79 <dt>image</dt>
     80 <dd>the image. </dd>
     81 
     82 <dd> </dd>
     83 <dt>exception</dt>
     84 <dd>return any errors or warnings in this structure. </dd>
     85 
     86 <dd>  </dd>
     87 </dl>
     88 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireVirtualCacheView">AcquireVirtualCacheView</a></h2>
     89 
     90 <p>AcquireVirtualCacheView() acquires a virtual view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself. It always succeeds but may return a warning or informational exception.</p>
     91 
     92 <p>The format of the AcquireVirtualCacheView method is:</p>
     93 
     94 <pre class="text">
     95 CacheView *AcquireVirtualCacheView(const Image *image,
     96   ExceptionInfo *exception)
     97 </pre>
     98 
     99 <p>A description of each parameter follows:</p>
    100 
    101 <dd>
    102 </dd>
    103 
    104 <dd> </dd>
    105 <dl class="dl-horizontal">
    106 <dt>image</dt>
    107 <dd>the image. </dd>
    108 
    109 <dd> </dd>
    110 <dt>exception</dt>
    111 <dd>return any errors or warnings in this structure. </dd>
    112 
    113 <dd>  </dd>
    114 </dl>
    115 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="CloneCacheView">CloneCacheView</a></h2>
    116 
    117 <p>CloneCacheView()  makes an exact copy of the specified cache view.</p>
    118 
    119 <p>The format of the CloneCacheView method is:</p>
    120 
    121 <pre class="text">
    122 CacheView *CloneCacheView(const CacheView *cache_view)
    123 </pre>
    124 
    125 <p>A description of each parameter follows:</p>
    126 
    127 <dd>
    128 </dd>
    129 
    130 <dd> </dd>
    131 <dl class="dl-horizontal">
    132 <dt>cache_view</dt>
    133 <dd>the cache view. </dd>
    134 
    135 <dd>  </dd>
    136 </dl>
    137 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="DestroyCacheView">DestroyCacheView</a></h2>
    138 
    139 <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p>
    140 
    141 <p>The format of the DestroyCacheView method is:</p>
    142 
    143 <pre class="text">
    144 CacheView *DestroyCacheView(CacheView *cache_view)
    145 </pre>
    146 
    147 <p>A description of each parameter follows:</p>
    148 
    149 <dd>
    150 </dd>
    151 
    152 <dd> </dd>
    153 <dl class="dl-horizontal">
    154 <dt>cache_view</dt>
    155 <dd>the cache view. </dd>
    156 
    157 <dd>  </dd>
    158 </dl>
    159 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
    160 
    161 <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>
    162 
    163 <p>The format of the GetCacheViewAuthenticPixels method is:</p>
    164 
    165 <pre class="text">
    166 Quantum *GetCacheViewAuthenticPixels(CacheView *cache_view,
    167   const ssize_t x,const ssize_t y,const size_t columns,
    168   const size_t rows,ExceptionInfo *exception)
    169 </pre>
    170 
    171 <p>A description of each parameter follows:</p>
    172 
    173 <dd>
    174 </dd>
    175 
    176 <dd> </dd>
    177 <dl class="dl-horizontal">
    178 <dt>cache_view</dt>
    179 <dd>the cache view. </dd>
    180 
    181 <dd> </dd>
    182 <dt>x,y,columns,rows</dt>
    183 <dd> These values define the perimeter of a region of pixels. </dd>
    184 
    185 <dd> </dd>
    186 <dt>exception</dt>
    187 <dd>return any errors or warnings in this structure. </dd>
    188 
    189 <dd>  </dd>
    190 </dl>
    191 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticMetacontent">GetCacheViewAuthenticMetacontent</a></h2>
    192 
    193 <p>GetCacheViewAuthenticMetacontent() returns the meta-content corresponding with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticMetacontent().  The meta-content are authentic and can be updated.</p>
    194 
    195 <p>The format of the GetCacheViewAuthenticMetacontent() method is:</p>
    196 
    197 <pre class="text">
    198 void *GetCacheViewAuthenticMetacontent(CacheView *cache_view)
    199 </pre>
    200 
    201 <p>A description of each parameter follows:</p>
    202 
    203 <dd>
    204 </dd>
    205 
    206 <dd> </dd>
    207 <dl class="dl-horizontal">
    208 <dt>cache_view</dt>
    209 <dd>the cache view. </dd>
    210 
    211 <dd>  </dd>
    212 </dl>
    213 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
    214 
    215 <p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels().  The pixels are authentic and therefore can be updated.</p>
    216 
    217 <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
    218 
    219 <pre class="text">
    220 Quantum *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
    221 </pre>
    222 
    223 <p>A description of each parameter follows:</p>
    224 
    225 <dd>
    226 </dd>
    227 
    228 <dd> </dd>
    229 <dl class="dl-horizontal">
    230 <dt>cache_view</dt>
    231 <dd>the cache view. </dd>
    232 
    233 <dd>  </dd>
    234 </dl>
    235 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
    236 
    237 <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p>
    238 
    239 <p>The format of the GetCacheViewColorspace method is:</p>
    240 
    241 <pre class="text">
    242 ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
    243 </pre>
    244 
    245 <p>A description of each parameter follows:</p>
    246 
    247 <dd>
    248 </dd>
    249 
    250 <dd> </dd>
    251 <dl class="dl-horizontal">
    252 <dt>cache_view</dt>
    253 <dd>the cache view. </dd>
    254 
    255 <dd>  </dd>
    256 </dl>
    257 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewImage">GetCacheViewImage</a></h2>
    258 
    259 <p>GetCacheViewImage() returns the image associated with the specified view.</p>
    260 
    261 <p>The format of the GetCacheViewImage method is:</p>
    262 
    263 <pre class="text">
    264 const Image *GetCacheViewImage(const CacheView *cache_view)
    265 </pre>
    266 
    267 <p>A description of each parameter follows:</p>
    268 
    269 <dd>
    270 </dd>
    271 
    272 <dd> </dd>
    273 <dl class="dl-horizontal">
    274 <dt>cache_view</dt>
    275 <dd>the cache view. </dd>
    276 
    277 <dd>  </dd>
    278 </dl>
    279 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
    280 
    281 <p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p>
    282 
    283 <p>The format of the GetCacheViewStorageClass method is:</p>
    284 
    285 <pre class="text">
    286 ClassType GetCacheViewStorageClass(const CacheView *cache_view)
    287 </pre>
    288 
    289 <p>A description of each parameter follows:</p>
    290 
    291 <dd>
    292 </dd>
    293 
    294 <dd> </dd>
    295 <dl class="dl-horizontal">
    296 <dt>cache_view</dt>
    297 <dd>the cache view. </dd>
    298 
    299 <dd>  </dd>
    300 </dl>
    301 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualMetacontent">GetCacheViewVirtualMetacontent</a></h2>
    302 
    303 <p>GetCacheViewVirtualMetacontent() returns the meta-content corresponding with the last call to GetCacheViewVirtualMetacontent().  The meta-content is virtual and therefore cannot be updated.</p>
    304 
    305 <p>The format of the GetCacheViewVirtualMetacontent() method is:</p>
    306 
    307 <pre class="text">
    308 const void *GetCacheViewVirtualMetacontent(
    309   const CacheView *cache_view)
    310 </pre>
    311 
    312 <p>A description of each parameter follows:</p>
    313 
    314 <dd>
    315 </dd>
    316 
    317 <dd> </dd>
    318 <dl class="dl-horizontal">
    319 <dt>cache_view</dt>
    320 <dd>the cache view. </dd>
    321 
    322 <dd>  </dd>
    323 </dl>
    324 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
    325 
    326 <p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels().  The pixels are virtual and therefore cannot be updated.</p>
    327 
    328 <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
    329 
    330 <pre class="text">
    331 const Quantum *GetCacheViewVirtualPixelQueue(
    332   const CacheView *cache_view)
    333 </pre>
    334 
    335 <p>A description of each parameter follows:</p>
    336 
    337 <dd>
    338 </dd>
    339 
    340 <dd> </dd>
    341 <dl class="dl-horizontal">
    342 <dt>cache_view</dt>
    343 <dd>the cache view. </dd>
    344 
    345 <dd>  </dd>
    346 </dl>
    347 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
    348 
    349 <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>
    350 
    351 <p>The format of the GetCacheViewVirtualPixels method is:</p>
    352 
    353 <pre class="text">
    354 const Quantum *GetCacheViewVirtualPixels(
    355   const CacheView *cache_view,const ssize_t x,const ssize_t y,
    356   const size_t columns,const size_t rows,ExceptionInfo *exception)
    357 </pre>
    358 
    359 <p>A description of each parameter follows:</p>
    360 
    361 <dd>
    362 </dd>
    363 
    364 <dd> </dd>
    365 <dl class="dl-horizontal">
    366 <dt>cache_view</dt>
    367 <dd>the cache view. </dd>
    368 
    369 <dd> </dd>
    370 <dt>x,y,columns,rows</dt>
    371 <dd> These values define the perimeter of a region of pixels. </dd>
    372 
    373 <dd> </dd>
    374 <dt>exception</dt>
    375 <dd>return any errors or warnings in this structure. </dd>
    376 
    377 <dd>  </dd>
    378 </dl>
    379 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
    380 
    381 <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.</p>
    382 
    383 <p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
    384 
    385 <pre class="text">
    386 MagickBooleaNType GetOneCacheViewAuthenticPixel(
    387   const CacheView *cache_view,const ssize_t x,const ssize_t y,
    388   Quantum *pixel,ExceptionInfo *exception)
    389 </pre>
    390 
    391 <p>A description of each parameter follows:</p>
    392 
    393 <dd>
    394 </dd>
    395 
    396 <dd> </dd>
    397 <dl class="dl-horizontal">
    398 <dt>cache_view</dt>
    399 <dd>the cache view. </dd>
    400 
    401 <dd> </dd>
    402 <dt>x,y</dt>
    403 <dd> These values define the offset of the pixel. </dd>
    404 
    405 <dd> </dd>
    406 <dt>pixel</dt>
    407 <dd>return a pixel at the specified (x,y) location. </dd>
    408 
    409 <dd> </dd>
    410 <dt>exception</dt>
    411 <dd>return any errors or warnings in this structure. </dd>
    412 
    413 <dd>  </dd>
    414 </dl>
    415 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
    416 
    417 <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>
    418 
    419 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
    420 
    421 <pre class="text">
    422 MagickBooleanType GetOneCacheViewVirtualPixel(
    423   const CacheView *cache_view,const ssize_t x,const ssize_t y,
    424   Quantum *pixel,ExceptionInfo *exception)
    425 </pre>
    426 
    427 <p>A description of each parameter follows:</p>
    428 
    429 <dd>
    430 </dd>
    431 
    432 <dd> </dd>
    433 <dl class="dl-horizontal">
    434 <dt>cache_view</dt>
    435 <dd>the cache view. </dd>
    436 
    437 <dd> </dd>
    438 <dt>x,y</dt>
    439 <dd> These values define the offset of the pixel. </dd>
    440 
    441 <dd> </dd>
    442 <dt>pixel</dt>
    443 <dd>return a pixel at the specified (x,y) location. </dd>
    444 
    445 <dd> </dd>
    446 <dt>exception</dt>
    447 <dd>return any errors or warnings in this structure. </dd>
    448 
    449 <dd>  </dd>
    450 </dl>
    451 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixelInfo">GetOneCacheViewVirtualPixelInfo</a></h2>
    452 
    453 <p>GetOneCacheViewVirtualPixelInfo() 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>
    454 
    455 <p>The format of the GetOneCacheViewVirtualPixelInfo method is:</p>
    456 
    457 <pre class="text">
    458 MagickBooleanType GetOneCacheViewVirtualPixelInfo(
    459   const CacheView *cache_view,const ssize_t x,const ssize_t y,
    460   PixelInfo *pixel,ExceptionInfo *exception)
    461 </pre>
    462 
    463 <p>A description of each parameter follows:</p>
    464 
    465 <dd>
    466 </dd>
    467 
    468 <dd> </dd>
    469 <dl class="dl-horizontal">
    470 <dt>cache_view</dt>
    471 <dd>the cache view. </dd>
    472 
    473 <dd> </dd>
    474 <dt>x,y</dt>
    475 <dd> These values define the offset of the pixel. </dd>
    476 
    477 <dd> </dd>
    478 <dt>pixel</dt>
    479 <dd>return a pixel at the specified (x,y) location. </dd>
    480 
    481 <dd> </dd>
    482 <dt>exception</dt>
    483 <dd>return any errors or warnings in this structure. </dd>
    484 
    485 <dd>  </dd>
    486 </dl>
    487 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
    488 
    489 <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>
    490 
    491 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
    492 
    493 <pre class="text">
    494 MagickBooleanType GetOneCacheViewVirtualMethodPixel(
    495   const CacheView *cache_view,
    496   const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
    497   const ssize_t y,Quantum *pixel,ExceptionInfo *exception)
    498 </pre>
    499 
    500 <p>A description of each parameter follows:</p>
    501 
    502 <dd>
    503 </dd>
    504 
    505 <dd> </dd>
    506 <dl class="dl-horizontal">
    507 <dt>cache_view</dt>
    508 <dd>the cache view. </dd>
    509 
    510 <dd> </dd>
    511 <dt>virtual_pixel_method</dt>
    512 <dd>the virtual pixel method. </dd>
    513 
    514 <dd> </dd>
    515 <dt>x,y</dt>
    516 <dd> These values define the offset of the pixel. </dd>
    517 
    518 <dd> </dd>
    519 <dt>pixel</dt>
    520 <dd>return a pixel at the specified (x,y) location. </dd>
    521 
    522 <dd> </dd>
    523 <dt>exception</dt>
    524 <dd>return any errors or warnings in this structure. </dd>
    525 
    526 <dd>  </dd>
    527 </dl>
    528 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
    529 
    530 <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>
    531 
    532 <p>The format of the QueueCacheViewAuthenticPixels method is:</p>
    533 
    534 <pre class="text">
    535 Quantum *QueueCacheViewAuthenticPixels(CacheView *cache_view,
    536   const ssize_t x,const ssize_t y,const size_t columns,
    537   const size_t rows,ExceptionInfo *exception)
    538 </pre>
    539 
    540 <p>A description of each parameter follows:</p>
    541 
    542 <dd>
    543 </dd>
    544 
    545 <dd> </dd>
    546 <dl class="dl-horizontal">
    547 <dt>cache_view</dt>
    548 <dd>the cache view. </dd>
    549 
    550 <dd> </dd>
    551 <dt>x,y,columns,rows</dt>
    552 <dd> These values define the perimeter of a region of pixels. </dd>
    553 
    554 <dd> </dd>
    555 <dt>exception</dt>
    556 <dd>return any errors or warnings in this structure. </dd>
    557 
    558 <dd>  </dd>
    559 </dl>
    560 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
    561 
    562 <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p>
    563 
    564 <p>The format of the SetCacheViewStorageClass method is:</p>
    565 
    566 <pre class="text">
    567 MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
    568   const ClassType storage_class,ExceptionInfo *exception)
    569 </pre>
    570 
    571 <p>A description of each parameter follows:</p>
    572 
    573 <dd>
    574 </dd>
    575 
    576 <dd> </dd>
    577 <dl class="dl-horizontal">
    578 <dt>cache_view</dt>
    579 <dd>the cache view. </dd>
    580 
    581 <dd> </dd>
    582 <dt>storage_class</dt>
    583 <dd>the image storage class: PseudoClass or DirectClass. </dd>
    584 
    585 <dd> </dd>
    586 <dt>exception</dt>
    587 <dd>return any errors or warnings in this structure. </dd>
    588 
    589 <dd>  </dd>
    590 </dl>
    591 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
    592 
    593 <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p>
    594 
    595 <p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
    596 
    597 <pre class="text">
    598 MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
    599   const VirtualPixelMethod virtual_pixel_method)
    600 </pre>
    601 
    602 <p>A description of each parameter follows:</p>
    603 
    604 <dd>
    605 </dd>
    606 
    607 <dd> </dd>
    608 <dl class="dl-horizontal">
    609 <dt>cache_view</dt>
    610 <dd>the cache view. </dd>
    611 
    612 <dd> </dd>
    613 <dt>virtual_pixel_method</dt>
    614 <dd>the virtual pixel method. </dd>
    615 
    616 <dd>  </dd>
    617 </dl>
    618 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
    619 
    620 <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>
    621 
    622 <p>The format of the SyncCacheViewAuthenticPixels method is:</p>
    623 
    624 <pre class="text">
    625 MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
    626   ExceptionInfo *exception)
    627 </pre>
    628 
    629 <p>A description of each parameter follows:</p>
    630 
    631 <dd>
    632 </dd>
    633 
    634 <dd> </dd>
    635 <dl class="dl-horizontal">
    636 <dt>cache_view</dt>
    637 <dd>the cache view. </dd>
    638 
    639 <dd> </dd>
    640 <dt>exception</dt>
    641 <dd>return any errors or warnings in this structure. </dd>
    642 
    643 <dd>  </dd>
    644 </dl>
    645 </div>
    646   <footer class="magick-footer">
    647     <p><a href="../support.html">Donate</a> 
    648      <a href="../sitemap.html">Sitemap</a> 
    649     <a href="../links.html">Related</a> 
    650     <a href="../architecture.html">Architecture</a>
    651 </p>
    652     <p><a href="cache-view.html#">Back to top</a> 
    653     <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> 
    654     <a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
    655         <p><small>  1999-2016 ImageMagick Studio LLC</small></p>
    656   </footer>
    657 </div><!-- /.container -->
    658 
    659   <script src="https://localhost/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
    660   <script src="../js/magick.html"></script>
    661 </div>
    662 </body>
    663 </html>
    664