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