blob: 4a5cbc868472599334afed324a9d2129725fe366 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html version="-//W3C//DTD XHTML 1.1//EN"
xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.w3.org/1999/xhtml
http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
<meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"/>
<title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title>
<meta http-equiv="content-language" content="en-US"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta http-equiv="reply-to" content="magick-users@imagemagick.org"/>
<meta name="application-name" content="ImageMagick"/>
<meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition, resize, rotate, shear, distort or transform images automagically."/>
<meta name="application-url" content="http://www.imagemagick.org"/>
<meta name="generator" content="PHP"/>
<meta name="keywords" content="magickcore, c, api, for, imagemagick:, cache, views, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
<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-2012 ImageMagick Studio LLC"/>
<meta name="distribution" content="Global"/>
<link rel="icon" href="../../images/wand.png"/>
<link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
<link rel="canonical" href="../../index.html" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
<!-- Add jQuery library -->
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
<!-- Add mousewheel plugin (this is optional) -->
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
<!-- Add fancyBox -->
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen" />
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
<!-- Optionally add helpers - button, thumbnail and/or media -->
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen" />
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen" />
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
<script type="text/javascript">
$(document).ready(function() {
$(".fancybox").fancybox();
});
</script>
<!-- ImageMagick style -->
<style type="text/css" media="all">
@import url("../../www/magick.css");
</style>
</head>
<body id="www-imagemagick-org">
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'offline-script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-40133312-1', 'imagemagick.org');
ga('send', 'pageview');
</script>
<div class="titlebar">
<div style="margin: 17px auto; float: left;">
<script type="text/javascript">
<!--
google_ad_client = "pub-3129977114552745";
google_ad_slot = "5439289906";
google_ad_width = 728;
google_ad_height = 90;
//-->
</script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</div>
<a href="../../discourse-server">
<img src="../../images/logo.jpg"
alt="ImageMagick Logo"
style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
<a href="../../index.html">
<img src="../../images/sprite.jpg"
alt="ImageMagick Sprite"
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
</div>
<div class="westbar">
<div class="menu">
<a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
</div>
<div class="menu">
<a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
</div>
<div class="sub">
<a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
</div>
<div class="sub">
<a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
</div>
<div class="sub">
<a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
</div>
<div class="sub">
<a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
</div>
<div class="sub">
<a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
</div>
<div class="sub">
<a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
</div>
<div class="menu">
<a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
</div>
<div class="sub">
<a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
</div>
<div class="sub">
<a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
</div>
<div class="sub">
<a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
</div>
<div class="sub">
<a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
</div>
<div class="sub">
<a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
</div>
<div class="menu">
<a title="Resources" href="../../www/resources.html">Resources</a>
</div>
<div class="menu">
<a title="Architecture" href="../../www/architecture.html">Architecture</a>
</div>
<div class="menu">
<a title="Download" href="../../www/download.html">Download</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Site Map" href="../../www/sitemap.html">Site Map</a>
</div>
<div class="sub">
<a title="Site Map: Links" href="../../www/links.html">Links</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Support ImageMagick Development" href="../../www/support.html">Support ImageMagick Development</a>
</div>
</div>
<div class="eastbar">
<script type="text/javascript">
/* <![CDATA[ */
(function() {
var po = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
po.type = 'text/javascript';
po.async = true;
po.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
var script = document.getElementsByTagName('offline-script')[0];
script.parentNode.insertBefore(po, script);
})();
/* ]]> */
</script>
<div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a></div>
<noscript>
<a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
<img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0" /></a>
</noscript>
<div class="g-plusone" id="gplusone"></div>
<script type="text/javascript">
/* <![CDATA[ */
window.___gcfg = {
lang: 'en-US'
};
(function() {
var po = document.createElement('offline-script');
po.type = 'text/javascript';
po.async = true;
po.src = 'https://apis.google.com/js/plusone.js';
var script = document.getElementsByTagName('offline-script')[0];
script.parentNode.insertBefore(po, script);
})();
var gplusone = document.getElementById("gplusone");
gplusone.setAttribute("data-size","medium");
gplusone.setAttribute("data-count","true");
/* ]]> */
</script>
</div>
<div class="main">
<h1>Module cache-view Methods</h1>
<p class="navigation-index">[<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#GetCacheViewChannels">GetCacheViewChannels</a> &#8226; <a href="cache-view.html#GetCacheViewColorspace">GetCacheViewColorspace</a> &#8226; <a href="cache-view.html#GetCacheViewException">GetCacheViewException</a> &#8226; <a href="cache-view.html#GetCacheViewStorageClass">GetCacheViewStorageClass</a> &#8226; <a href="cache-view.html#GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a> &#8226; <a href="cache-view.html#GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a> &#8226; <a href="cache-view.html#GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a> &#8226; <a href="cache-view.html#GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a> &#8226; <a href="cache-view.html#GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</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#GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</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>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireAuthenticCacheView">AcquireAuthenticCacheView</a></h2>
<div class="doc-section">
<p>AcquireAuthenticCacheView() acquires an authentic view into the pixel cache.</p>
<p>The format of the AcquireAuthenticCacheView method is:</p>
<pre class="code">
CacheView *AcquireAuthenticCacheView(const Image *image,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h5>image</h5>
<p>the image.</p>
<h5>exception</h5>
<p>return any errors or warnings in this structure.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireVirtualCacheView">AcquireVirtualCacheView</a></h2>
<div class="doc-section">
<p>AcquireVirtualCacheView() acquires a virtual view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p>
<p>The format of the AcquireVirtualCacheView method is:</p>
<pre class="code">
CacheView *AcquireVirtualCacheView(const Image *image,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h5>image</h5>
<p>the image.</p>
<h5>exception</h5>
<p>return any errors or warnings in this structure.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="CloneCacheView">CloneCacheView</a></h2>
<div class="doc-section">
<p>CloneCacheView() makes an exact copy of the specified cache view.</p>
<p>The format of the CloneCacheView method is:</p>
<pre class="code">
CacheView *CloneCacheView(const CacheView *cache_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="DestroyCacheView">DestroyCacheView</a></h2>
<div class="doc-section">
<p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireVirtualCacheView().</p>
<p>The format of the DestroyCacheView method is:</p>
<pre class="code">
CacheView *DestroyCacheView(CacheView *cache_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewChannels">GetCacheViewChannels</a></h2>
<div class="doc-section">
<p>GetCacheViewChannels() returns the image pixel channels associated with the specified view.</p>
<p>The format of the GetCacheViewChannels method is:</p>
<pre class="code">
size_t GetCacheViewChannels(const CacheView *cache_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
<div class="doc-section">
<p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p>
<p>The format of the GetCacheViewColorspace method is:</p>
<pre class="code">
ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewException">GetCacheViewException</a></h2>
<div class="doc-section">
<p>GetCacheViewException() returns the image exception associated with the specified view.</p>
<p>The format of the GetCacheViewException method is:</p>
<pre class="code">
ExceptionInfo GetCacheViewException(const CacheView *cache_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
<div class="doc-section">
<p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p>
<p>The format of the GetCacheViewStorageClass method is:</p>
<pre class="code">
ClassType GetCacheViewStorageClass(const CacheView *cache_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
<div class="doc-section">
<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="code">
PixelPacket *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>
<h5>cache_view</h5>
<p>the cache view.</p>
<h5>x,y,columns,rows</h5>
<p>These values define the perimeter of a region of pixels.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
<div class="doc-section">
<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="code">
MagickBooleaNType GetOneCacheViewAuthenticPixel(
const CacheView *cache_view,const ssize_t x,const ssize_t y,
Pixelpacket *pixel,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
<h5>x,y</h5>
<p>These values define the offset of the pixel.</p>
<h5>pixel</h5>
<p>return a pixel at the specified (x,y) location.</p>
<h5>exception</h5>
<p>return any errors or warnings in this structure.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
<div class="doc-section">
<p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.</p>
<p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
<pre class="code">
IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
<div class="doc-section">
<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="code">
PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
<div class="doc-section">
<p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.</p>
<p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
<pre class="code">
const IndexPacket *GetCacheViewVirtualIndexQueue(
const CacheView *cache_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
<div class="doc-section">
<p>GetCacheViewVirtualPixelQueue() returns the 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="code">
const PixelPacket *GetCacheViewVirtualPixelQueue(
const CacheView *cache_view)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
<div class="doc-section">
<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="code">
const PixelPacket *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>
<h5>cache_view</h5>
<p>the cache view.</p>
<h5>x,y,columns,rows</h5>
<p>These values define the perimeter of a region of pixels.</p>
<h5>exception</h5>
<p>return any errors or warnings in this structure.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
<div class="doc-section">
<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="code">
MagickBooleanType GetOneCacheViewVirtualPixel(
const CacheView *cache_view,const ssize_t x,const ssize_t y,
PixelPacket *pixel,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
<h5>x,y</h5>
<p>These values define the offset of the pixel.</p>
<h5>pixel</h5>
<p>return a pixel at the specified (x,y) location.</p>
<h5>exception</h5>
<p>return any errors or warnings in this structure.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
<div class="doc-section">
<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="code">
MagickBooleanType GetOneCacheViewVirtualMethodPixel(
const CacheView *cache_view,
const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
<h5>virtual_pixel_method</h5>
<p>the virtual pixel method.</p>
<h5>x,y</h5>
<p>These values define the offset of the pixel.</p>
<h5>pixel</h5>
<p>return a pixel at the specified (x,y) location.</p>
<h5>exception</h5>
<p>return any errors or warnings in this structure.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
<div class="doc-section">
<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="code">
PixelPacket *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>
<h5>cache_view</h5>
<p>the cache view.</p>
<h5>x,y,columns,rows</h5>
<p>These values define the perimeter of a region of pixels.</p>
<h5>exception</h5>
<p>return any errors or warnings in this structure.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
<div class="doc-section">
<p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p>
<p>The format of the SetCacheViewStorageClass method is:</p>
<pre class="code">
MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
const ClassType storage_class)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
<h5>storage_class</h5>
<p>the image storage class: PseudoClass or DirectClass.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
<div class="doc-section">
<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="code">
MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
const VirtualPixelMethod virtual_pixel_method)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
<h5>virtual_pixel_method</h5>
<p>the virtual pixel method.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
<div class="doc-section">
<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="code">
MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h5>cache_view</h5>
<p>the cache view.</p>
<h5>exception</h5>
<p>return any errors or warnings in this structure.</p>
</div>
</div>
<div id="linkbar">
<span id="linkbar-west"> </span>
<span id="linkbar-center">
<a href="http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> &#8226;
<a href="../../discourse-server">Discourse Server</a> &#8226;
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> &#8226;
<a href="http://jqmagick.imagemagick.org/">JqMagick</a>
</span>
<span id="linkbar-east"> </span>
</div>
<div class="footer">
<span id="footer-west">© 1999-2013 ImageMagick Studio LLC</span>
<span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>