<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<style type="text/css" media="screen,projection"><!--
@import url("../../www/magick.css");
//--></style>
<meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
<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="Generator" content="PHP"/>
<meta name="Keywords" content="magickcore, c, api, for, imagemagick:, cache, views, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject"/>
<meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
<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-2008 ImageMagick Studio LLC"/>
<meta name="Distribution" content="Global"/>
<link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
</head>
<body id="www-imagemagick-org">
<table id="titlebar" style="width: 100%;background-color: #f5f5f5" cellpadding="0" cellspacing="0" border="0" summary="ImageMagick">
<tbody>
<tr valign="top">
<td align="left"><a href="../../index.html"><img id="titlebar-west" src="../../images/script.png" alt="[ImageMagick]" width="350" height="60" border="0" vspace="28" name="titlebar-west"/></a></td>
<td align="left"><a href="https://secure.networkredux.com/affiliate/idevaffiliate.html?id=146" target="1613804943"><img id="titlebar-west" src="../../images/networkredux.png" alt="[sponsor]" border="0" vspace="45" name="titlebar-west"/></a></td>
<td width="99%"><br /> </td>
<td style="background-color: white" align="right"><a href="../../index.html"><img src="../../images/sprite.jpg" alt="" width="114" height="118" border="0" name="titlebar-east"/></a></td>
<td style="background-color: white" align="right"><a href="http://www.imagemagick.org/discourse-server/" target="706000298"><img id="titlebar-east" src="../../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east"/></a></td>
</tr>
</tbody>
</table>
<table style="width: 100%" border="0" cellpadding="0" cellspacing="0" summary="">
<tbody>
<tr valign="top" style="height: 100%;">
<td id="menu" width="1%" height="100%">
<p><a href="#main">Skip to page contents</a></p>
<font size="-1">
<span>[</span>
<a href="../../index.html">About ImageMagick</a>
<span>]</span><br /><span>[</span>
<a href="../../www/command-line-tools.html">Command-line Tools</a>
<a href="../../www/command-line-processing.html" class="sub">Processing</a>
<a href="../../www/command-line-options.html" class="sub">Options</a>
<a href="http://www.imagemagick.org/Usage/" target="642040829" class="sub">Usage</a>
<a href="../../www/api.html">Program Interfaces</a>
<a href="../../www/magick-wand.html" class="sub">MagickWand</a>
<a href="../../www/magick-core.html" class="sub">MagickCore</a>
<a href="../../www/perl-magick.html" class="sub">PerlMagick</a>
<a href="../../Magick++/" target="1813001550" class="sub">Magick++</a>
<a href="../../www/architecture.html">Architecture</a>
<span>]</span><br /><span>[</span>
<a href="../../www/install-source.html">Install from Source</a>
<a href="../../www/install-source.html#unix" class="sub">Unix</a>
<a href="../../www/install-source.html#windows" class="sub">Windows</a>
<a href="../../www/binary-releases.html">Binary Releases</a>
<a href="../../www/binary-releases.html#unix" class="sub">Unix</a>
<a href="../../www/binary-releases.html#macosx" class="sub">Mac OS X</a>
<a href="../../www/binary-releases.html#windows" class="sub">Windows</a>
<a href="../../www/resources.html">Resources</a>
<span>]</span><br /><span>[</span>
<a href="../../www/download.html">Download</a>
<span>]</span><br /><span>[</span>
<a href="../../www/sitemap.html">Site Map</a>
<a href="../../www/links.html" class="sub">Links</a>
<span>]</span><br /><span>[</span>
<a href="../../www/sponsors.html">Sponsors:</a>
<fieldset>
<a href="http://www.hitflip.co.uk/books/" class="sponsor" target="sponsor">Swap Books</a><!-- 200802010000 -->
<br />
<a href="http://business-directory.com"><img src="../../images/business+directory.gif" alt="[Business + Directory]" width="105" height="60" border="0" name="business+directory"/></a> <!-- 200808010160 -->
<br />
<a href="http://analogik.com"><img src="../../images/analogik.png" alt="[Electronic Music]" width="105" height="60" border="0" name="analogik"/></a> <!-- 200804030160 -->
</fieldset>
<span>]</span>
</font>
</td>
<td id="main" valign="top">
<p class="navigation-index">[ <a href="#AcquireCacheViewIndexes">AcquireCacheViewIndexes</a> | <a href="#AcquireCacheViewPixels">AcquireCacheViewPixels</a> | <a href="#AcquireCacheViewPixels">AcquireCacheViewPixels</a> | <a href="#CloneCacheView">CloneCacheView</a> | <a href="#CloseCacheView">CloseCacheView</a> | <a href="#GetCacheViewColorspace">GetCacheViewColorspace</a> | <a href="#GetCacheViewException">GetCacheViewException</a> | <a href="#GetCacheViewIndexes">GetCacheViewIndexes</a> | <a href="#GetCacheViewPixels">GetCacheViewPixels</a> | <a href="#GetCacheViewStorageClass">GetCacheViewStorageClass</a> | <a href="#GetOneCacheViewPixel">GetOneCacheViewPixel</a> | <a href="#OpenCacheView">OpenCacheView</a> | <a href="#SetCacheView">SetCacheView</a> | <a href="#SetCacheViewStorageClass">SetCacheViewStorageClass</a> | <a href="#SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a> | <a href="#SyncCacheView">SyncCacheView</a> ]</p>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="AcquireCacheViewIndexes">AcquireCacheViewIndexes</a></h2>
</div>
<p>AcquireCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
<p>The format of the AcquireCacheViewIndexes method is:</p>
<pre class="code">
const IndexPacket *AcquireCacheViewIndexes(const ViewInfo *view_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="AcquireCacheViewPixels">AcquireCacheViewPixels</a></h2>
</div>
<p>AcquireCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
<p>The format of the AcquireCacheViewPixels method is:</p>
<pre class="code">
const PixelPacket *AcquireCacheViewPixels(const ViewInfo *view_info,
const long x,const long y,const unsigned long columns,
const unsigned long rows,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<h5>x,y,columns,rows</h5>
<ol><p>These values define the perimeter of a region of pixels.</p></ol>
<h5>exception</h5>
<ol><p>Return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="AcquireCacheViewPixels">AcquireCacheViewPixels</a></h2>
</div>
<p>AcquireCacheViewPixels() 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 GetOneCacheViewPixel() instead.</p></ol>
<p>The format of the AcquireOneCacheViewPixel method is:</p>
<pre class="code">
PixelPacket AcquireOneCacheViewPixel(const ViewInfo *view_info,
const long x,const long y,ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<h5>x,y</h5>
<ol><p>These values define the offset of the pixel.</p></ol>
<h5>exception</h5>
<ol><p>Return any errors or warnings in this structure.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="CloneCacheView">CloneCacheView</a></h2>
</div>
<p>CloneCacheView() makes an exact copy of the specified cache view.</p></ol>
<p>The format of the CloneCacheView method is:</p>
<pre class="code">
ViewInfo *CloneCacheView(const ViewInfo *view_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the cache view.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="CloseCacheView">CloseCacheView</a></h2>
</div>
<p>CloseCacheView() closes the specified view returned by a previous call to OpenCacheView().</p></ol>
<p>The format of the CloseCacheView method is:</p>
<pre class="code">
ViewInfo *CloseCacheView(ViewInfo *view_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
</div>
<p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p></ol>
<p>The format of the GetCacheViewColorspace method is:</p>
<pre class="code">
ColorspaceType GetCacheViewColorspace(const ViewInfo *view_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="GetCacheViewException">GetCacheViewException</a></h2>
</div>
<p>GetCacheViewException() returns the image exception associated with the specified view.</p></ol>
<p>The format of the GetCacheViewException method is:</p>
<pre class="code">
ExceptionInfo GetCacheViewException(const ViewInfo *view_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="GetCacheViewIndexes">GetCacheViewIndexes</a></h2>
</div>
<p>GetCacheViewIndexes() returns the indexes associated with the specified view.</p></ol>
<p>The format of the GetCacheViewIndexes method is:</p>
<pre class="code">
IndexPacket *GetCacheViewIndexes(const ViewInfo *view_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="GetCacheViewPixels">GetCacheViewPixels</a></h2>
</div>
<p>GetCacheViewPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
<p>The format of the GetCacheViewPixels method is:</p>
<pre class="code">
PixelPacket *GetCacheViewPixels(ViewInfo *view_info,const long x,
const long y,const unsigned long columns,const unsigned long rows)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<h5>x,y,columns,rows</h5>
<ol><p>These values define the perimeter of a region of pixels.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
</div>
<p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p></ol>
<p>The format of the GetCacheViewStorageClass method is:</p>
<pre class="code">
ClassType GetCacheViewStorageClass(const ViewInfo *view_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="GetOneCacheViewPixel">GetOneCacheViewPixel</a></h2>
</div>
<p>GetOneCacheViewPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
<p>The format of the GetOneCacheViewPixel method is:</p>
<pre class="code">
PixelPacket GetOneCacheViewPixel(const ViewInfo *view_info,
const long x,const long y)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<h5>x,y</h5>
<ol><p>These values define the offset of the pixel.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="OpenCacheView">OpenCacheView</a></h2>
</div>
<p>OpenCacheView() opens a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
<p>The format of the OpenCacheView method is:</p>
<pre class="code">
ViewInfo *OpenCacheView(const Image *image)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>image</h5>
<ol><p>the image.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="SetCacheView">SetCacheView</a></h2>
</div>
<p>SetCacheView() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
<p>The format of the SetCacheView method is:</p>
<pre class="code">
PixelPacket *SetCacheView(ViewInfo *view_info,const long x,const long y,
const unsigned long columns,const unsigned long rows)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<h5>x,y,columns,rows</h5>
<ol><p>These values define the perimeter of a region of pixels.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
</div>
<p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p></ol>
<p>The format of the SetCacheViewStorageClass method is:</p>
<pre class="code">
MagickBooleanType SetCacheViewStorageClass(ViewInfo *view_info,
const ClassType storage_class)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<h5>storage_class</h5>
<ol><p>the image storage class: PseudoClass or DirectClass.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
</div>
<p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p></ol>
<p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
<pre class="code">
MagickBooleanType SetCacheViewVirtualPixelMethod(ViewInfo *view_info,
const VirtualPixelMethod virtual_pixel_method)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
<h5>virtual_pixel_method</h5>
<ol><p>the virtual pixel method.</p></ol>
<div style="margin: auto;">
<h2><a href="http://magick.imagemagick.org/viewvc/bin/cgi/viewvc.cgi/svn/ImageMagick/trunk/magick/cache-view.c
?view=markup" target="source" name="SyncCacheView">SyncCacheView</a></h2>
</div>
<p>SyncCacheView() saves the view_info pixels to the in-memory or disk cache. The method returns MagickTrue if the pixel region is synced, otherwise MagickFalse.</p></ol>
<p>The format of the SyncCacheView method is:</p>
<pre class="code">
MagickBooleanType SyncCacheView(ViewInfo *view_info)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>view_info</h5>
<ol><p>the address of a structure of type ViewInfo.</p></ol>
</td>
<td id="margin" width="1%" height="100%" valign="top" align="right"> </td>
</tr>
</tbody>
</table>
<div id="linkbar">
<a href="http://www.imagemagick.org/discourse-server/" target="820813435">Discourse Server</a> •
<a href="../../www/mailing-list.html">Mailing Lists</a> •
<a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi" target="1926547956">ImageMagick Studio</a>
</div>
<div id="footer">
<span id="footer-west">© 1999-2008 ImageMagick Studio LLC</span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>
