| |
| |
| |
| |
| <!doctype html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <title>ImageMagick - MagickCore, C API: Cache Views</title> |
| <meta name="application-name" content="ImageMagick" /> |
| <meta name="description" content="Use ImageMagick® to create, edit, compose, and convert digital images. Resize an image, crop it, change its shades and colors, add captions, and more." /> |
| <meta name="application-url" content="https://imagemagick.org" /> |
| <meta name="generator" content="PHP" /> |
| <meta name="keywords" content="magickcore, c, api:, cache, views, image processing software" /> |
| <meta name="rating" content="GENERAL" /> |
| <meta name="robots" content="INDEX, FOLLOW" /> |
| <meta name="generator" content="ImageMagick Studio LLC" /> |
| <meta name="author" content="ImageMagick Studio LLC" /> |
| <meta name="revisit-after" content="2 DAYS" /> |
| <meta name="resource-type" content="document" /> |
| <meta name="copyright" content="Copyright (c) 1999-2020 ImageMagick Studio LLC" /> |
| <meta name="distribution" content="Global" /> |
| <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" /> |
| <meta property='og:url' content='../../' /> |
| <meta property='og:title' content='ImageMagick' /> |
| <meta property='og:image' content='../../../images/logo.png' /> |
| <meta property='og:type' content='website' /> |
| <meta property='og:site_name' content='ImageMagick' /> |
| <meta property='og:description' content="Create, Edit, Compose, or Convert Digital Images" /> |
| <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" /> |
| <link href="cache-view.html" rel="canonical" /> |
| <link href="../../../images/wand.png" rel="icon" /> |
| <link href="../../../images/wand.ico" rel="shortcut icon" /> |
| <link href="../../assets/magick.css" rel="stylesheet" /> |
| </head> |
| <body> |
| <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top"> |
| <div class="container-fluid"> |
| <a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../images/wand.ico"/></a> |
| <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation"> |
| <span class="navbar-toggler-icon"></span> |
| </button> |
| |
| <div class="collapse navbar-collapse" id="magick-navbars"> |
| <ul class="navbar-nav me-auto mb-2 mb-md-0"> |
| <li class="nav-item"> |
| <a class="nav-link " href="../../www/index.html">Home</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link " href="../../www/download.html">Download</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link " href="../../www/command-line-tools.html">Tools</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link " href="../../www/command-line-processing.html">CLI</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link " href="../../www/develop.html">Develop</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a> |
| </li> |
| <li class="nav-item"> |
| <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe> |
| </li> |
| </ul> |
| <form class="d-flex form-inline" action="https://imagemagick.org/script/search.php"> |
| <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search"> |
| <button class="btn btn-outline-success" type="submit" name="sa">Search</button> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="container"> |
| <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script> |
| <ins class="adsbygoogle" |
| style="display:block" |
| data-ad-client="ca-pub-3129977114552745" |
| data-ad-slot="6345125851" |
| data-full-width-responsive="true" |
| data-ad-format="horizontal"></ins> |
| <script> |
| (adsbygoogle = window.adsbygoogle || []).push({}); |
| </script> |
| |
| </div> |
| |
| <main class="container"> |
| <div class="magick-template"> |
| <div class="magick-header"> |
| <p class="text-center"><a href="cache-view.html#AcquireAuthenticCacheView">AcquireAuthenticCacheView</a> • <a href="cache-view.html#AcquireVirtualCacheView">AcquireVirtualCacheView</a> • <a href="cache-view.html#CloneCacheView">CloneCacheView</a> • <a href="cache-view.html#DestroyCacheView">DestroyCacheView</a> • <a href="cache-view.html#GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a> • <a href="cache-view.html#GetCacheViewAuthenticMetacontent">GetCacheViewAuthenticMetacontent</a> • <a href="cache-view.html#GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a> • <a href="cache-view.html#GetCacheViewColorspace">GetCacheViewColorspace</a> • <a href="cache-view.html#GetCacheViewImage">GetCacheViewImage</a> • <a href="cache-view.html#GetCacheViewStorageClass">GetCacheViewStorageClass</a> • <a href="cache-view.html#GetCacheViewVirtualMetacontent">GetCacheViewVirtualMetacontent</a> • <a href="cache-view.html#GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a> • <a href="cache-view.html#GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a> • <a href="cache-view.html#GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a> • <a href="cache-view.html#GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a> • <a href="cache-view.html#GetOneCacheViewVirtualPixelInfo">GetOneCacheViewVirtualPixelInfo</a> • <a href="cache-view.html#GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a> • <a href="cache-view.html#QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a> • <a href="cache-view.html#SetCacheViewStorageClass">SetCacheViewStorageClass</a> • <a href="cache-view.html#SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a> • <a href="cache-view.html#SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></p> |
| |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="AcquireAuthenticCacheView">AcquireAuthenticCacheView</a></h2> |
| |
| <p>AcquireAuthenticCacheView() acquires an authentic view into the pixel cache. It always succeeds but may return a warning or informational exception.</p> |
| |
| <p>The format of the AcquireAuthenticCacheView method is:</p> |
| |
| <pre class="text"> |
| CacheView *AcquireAuthenticCacheView(const Image *image, |
| ExceptionInfo *exception) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>image</dt> |
| <dd>the image. </dd> |
| |
| <dd> </dd> |
| <dt>exception</dt> |
| <dd>return any errors or warnings in this structure. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="AcquireVirtualCacheView">AcquireVirtualCacheView</a></h2> |
| |
| <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> |
| |
| <p>The format of the AcquireVirtualCacheView method is:</p> |
| |
| <pre class="text"> |
| CacheView *AcquireVirtualCacheView(const Image *image, |
| ExceptionInfo *exception) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>image</dt> |
| <dd>the image. </dd> |
| |
| <dd> </dd> |
| <dt>exception</dt> |
| <dd>return any errors or warnings in this structure. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="CloneCacheView">CloneCacheView</a></h2> |
| |
| <p>CloneCacheView() makes an exact copy of the specified cache view.</p> |
| |
| <p>The format of the CloneCacheView method is:</p> |
| |
| <pre class="text"> |
| CacheView *CloneCacheView(const CacheView *cache_view) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="DestroyCacheView">DestroyCacheView</a></h2> |
| |
| <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p> |
| |
| <p>The format of the DestroyCacheView method is:</p> |
| |
| <pre class="text"> |
| CacheView *DestroyCacheView(CacheView *cache_view) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2> |
| |
| <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> |
| |
| <p>The format of the GetCacheViewAuthenticPixels method is:</p> |
| |
| <pre class="text"> |
| Quantum *GetCacheViewAuthenticPixels(CacheView *cache_view, |
| const ssize_t x,const ssize_t y,const size_t columns, |
| const size_t rows,ExceptionInfo *exception) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| <dt>x,y,columns,rows</dt> |
| <dd> These values define the perimeter of a region of pixels. </dd> |
| |
| <dd> </dd> |
| <dt>exception</dt> |
| <dd>return any errors or warnings in this structure. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticMetacontent">GetCacheViewAuthenticMetacontent</a></h2> |
| |
| <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> |
| |
| <p>The format of the GetCacheViewAuthenticMetacontent() method is:</p> |
| |
| <pre class="text"> |
| void *GetCacheViewAuthenticMetacontent(CacheView *cache_view) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2> |
| |
| <p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be updated.</p> |
| |
| <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p> |
| |
| <pre class="text"> |
| Quantum *GetCacheViewAuthenticPixelQueue(CacheView *cache_view) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2> |
| |
| <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p> |
| |
| <p>The format of the GetCacheViewColorspace method is:</p> |
| |
| <pre class="text"> |
| ColorspaceType GetCacheViewColorspace(const CacheView *cache_view) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewImage">GetCacheViewImage</a></h2> |
| |
| <p>GetCacheViewImage() returns the image associated with the specified view.</p> |
| |
| <p>The format of the GetCacheViewImage method is:</p> |
| |
| <pre class="text"> |
| const Image *GetCacheViewImage(const CacheView *cache_view) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2> |
| |
| <p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p> |
| |
| <p>The format of the GetCacheViewStorageClass method is:</p> |
| |
| <pre class="text"> |
| ClassType GetCacheViewStorageClass(const CacheView *cache_view) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualMetacontent">GetCacheViewVirtualMetacontent</a></h2> |
| |
| <p>GetCacheViewVirtualMetacontent() returns the meta-content corresponding with the last call to GetCacheViewVirtualMetacontent(). The meta-content is virtual and therefore cannot be updated.</p> |
| |
| <p>The format of the GetCacheViewVirtualMetacontent() method is:</p> |
| |
| <pre class="text"> |
| const void *GetCacheViewVirtualMetacontent( |
| const CacheView *cache_view) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2> |
| |
| <p>GetCacheViewVirtualPixelQueue() returns the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p> |
| |
| <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p> |
| |
| <pre class="text"> |
| const Quantum *GetCacheViewVirtualPixelQueue( |
| const CacheView *cache_view) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2> |
| |
| <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> |
| |
| <p>The format of the GetCacheViewVirtualPixels method is:</p> |
| |
| <pre class="text"> |
| const Quantum *GetCacheViewVirtualPixels( |
| const CacheView *cache_view,const ssize_t x,const ssize_t y, |
| const size_t columns,const size_t rows,ExceptionInfo *exception) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| <dt>x,y,columns,rows</dt> |
| <dd> These values define the perimeter of a region of pixels. </dd> |
| |
| <dd> </dd> |
| <dt>exception</dt> |
| <dd>return any errors or warnings in this structure. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2> |
| |
| <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p> |
| |
| <p>The format of the GetOneCacheViewAuthenticPixel method is:</p> |
| |
| <pre class="text"> |
| MagickBooleaNType GetOneCacheViewAuthenticPixel( |
| const CacheView *cache_view,const ssize_t x,const ssize_t y, |
| Quantum *pixel,ExceptionInfo *exception) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| <dt>x,y</dt> |
| <dd> These values define the offset of the pixel. </dd> |
| |
| <dd> </dd> |
| <dt>pixel</dt> |
| <dd>return a pixel at the specified (x,y) location. </dd> |
| |
| <dd> </dd> |
| <dt>exception</dt> |
| <dd>return any errors or warnings in this structure. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2> |
| |
| <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> |
| |
| <p>The format of the GetOneCacheViewVirtualPixel method is:</p> |
| |
| <pre class="text"> |
| MagickBooleanType GetOneCacheViewVirtualPixel( |
| const CacheView *cache_view,const ssize_t x,const ssize_t y, |
| Quantum *pixel,ExceptionInfo *exception) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| <dt>x,y</dt> |
| <dd> These values define the offset of the pixel. </dd> |
| |
| <dd> </dd> |
| <dt>pixel</dt> |
| <dd>return a pixel at the specified (x,y) location. </dd> |
| |
| <dd> </dd> |
| <dt>exception</dt> |
| <dd>return any errors or warnings in this structure. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixelInfo">GetOneCacheViewVirtualPixelInfo</a></h2> |
| |
| <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> |
| |
| <p>The format of the GetOneCacheViewVirtualPixelInfo method is:</p> |
| |
| <pre class="text"> |
| MagickBooleanType GetOneCacheViewVirtualPixelInfo( |
| const CacheView *cache_view,const ssize_t x,const ssize_t y, |
| PixelInfo *pixel,ExceptionInfo *exception) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| <dt>x,y</dt> |
| <dd> These values define the offset of the pixel. </dd> |
| |
| <dd> </dd> |
| <dt>pixel</dt> |
| <dd>return a pixel at the specified (x,y) location. </dd> |
| |
| <dd> </dd> |
| <dt>exception</dt> |
| <dd>return any errors or warnings in this structure. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2> |
| |
| <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> |
| |
| <p>The format of the GetOneCacheViewVirtualPixel method is:</p> |
| |
| <pre class="text"> |
| MagickBooleanType GetOneCacheViewVirtualMethodPixel( |
| const CacheView *cache_view, |
| const VirtualPixelMethod virtual_pixel_method,const ssize_t x, |
| const ssize_t y,Quantum *pixel,ExceptionInfo *exception) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| <dt>virtual_pixel_method</dt> |
| <dd>the virtual pixel method. </dd> |
| |
| <dd> </dd> |
| <dt>x,y</dt> |
| <dd> These values define the offset of the pixel. </dd> |
| |
| <dd> </dd> |
| <dt>pixel</dt> |
| <dd>return a pixel at the specified (x,y) location. </dd> |
| |
| <dd> </dd> |
| <dt>exception</dt> |
| <dd>return any errors or warnings in this structure. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2> |
| |
| <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> |
| |
| <p>The format of the QueueCacheViewAuthenticPixels method is:</p> |
| |
| <pre class="text"> |
| Quantum *QueueCacheViewAuthenticPixels(CacheView *cache_view, |
| const ssize_t x,const ssize_t y,const size_t columns, |
| const size_t rows,ExceptionInfo *exception) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| <dt>x,y,columns,rows</dt> |
| <dd> These values define the perimeter of a region of pixels. </dd> |
| |
| <dd> </dd> |
| <dt>exception</dt> |
| <dd>return any errors or warnings in this structure. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2> |
| |
| <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p> |
| |
| <p>The format of the SetCacheViewStorageClass method is:</p> |
| |
| <pre class="text"> |
| MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view, |
| const ClassType storage_class,ExceptionInfo *exception) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| <dt>storage_class</dt> |
| <dd>the image storage class: PseudoClass or DirectClass. </dd> |
| |
| <dd> </dd> |
| <dt>exception</dt> |
| <dd>return any errors or warnings in this structure. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2> |
| |
| <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p> |
| |
| <p>The format of the SetCacheViewVirtualPixelMethod method is:</p> |
| |
| <pre class="text"> |
| MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view, |
| const VirtualPixelMethod virtual_pixel_method) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| <dt>virtual_pixel_method</dt> |
| <dd>the virtual pixel method. </dd> |
| |
| <dd> </dd> |
| </dl> |
| <h2><a href="../../api/MagickCore/cache-view_8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2> |
| |
| <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> |
| |
| <p>The format of the SyncCacheViewAuthenticPixels method is:</p> |
| |
| <pre class="text"> |
| MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view, |
| ExceptionInfo *exception) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <dd> |
| </dd> |
| |
| <dd> </dd> |
| <dl class="dl-horizontal"> |
| <dt>cache_view</dt> |
| <dd>the cache view. </dd> |
| |
| <dd> </dd> |
| <dt>exception</dt> |
| <dd>return any errors or warnings in this structure. </dd> |
| |
| <dd> </dd> |
| </dl> |
| </div> |
| </div> |
| </main><!-- /.container --> |
| <footer class="magick-footer"> |
| <div class="container-fluid"> |
| <a href="../../www/security-policy.html">Security</a> • |
| <a href="../../www/news.html">News</a> |
| |
| <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> |
| |
| <a href="../../www/links.html">Related</a> • |
| <a href="../../www/sitemap.html">Sitemap</a> |
| <br/> |
| <a href="../../www/support.html">Sponsor</a> • |
| <a href="../../www/cite.html">Cite</a> • |
| <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> • |
| <a href="../../www/contact.html">Contact Us</a> |
| <br/> |
| <a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> • |
| <a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 416.32" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path fill="currentColor" d="M160.83 416.32c193.2 0 298.92-160.22 298.92-298.92 0-4.51 0-9-.2-13.52A214 214 0 0 0 512 49.38a212.93 212.93 0 0 1-60.44 16.6 105.7 105.7 0 0 0 46.3-58.19 209 209 0 0 1-66.79 25.37 105.09 105.09 0 0 0-181.73 71.91 116.12 116.12 0 0 0 2.66 24c-87.28-4.3-164.73-46.3-216.56-109.82A105.48 105.48 0 0 0 68 159.6a106.27 106.27 0 0 1-47.53-13.11v1.43a105.28 105.28 0 0 0 84.21 103.06 105.67 105.67 0 0 1-47.33 1.84 105.06 105.06 0 0 0 98.14 72.94A210.72 210.72 0 0 1 25 370.84a202.17 202.17 0 0 1-25-1.43 298.85 298.85 0 0 0 160.83 46.92"/></svg></a> |
| <br/> |
| <small>© 1999-2021 ImageMagick Studio LLC</small> |
| </div> |
| </footer> |
| |
| <!-- Javascript assets --> |
| <script src="../../assets/magick.js" ></script> |
| </body> |
| </html> |