blob: 466d353867684a44f89dba162e297b25fa4bee6e [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +00007 <title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title>
cristy3ed852e2009-09-05 21:47:34 +00008 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000011 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +000012 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000013 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000014 <meta name="Generator" content="PHP"/>
15 <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, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +000016 <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"/>
cristy4103d562010-12-10 01:38:54 +000022 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000023 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000024 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000025 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +000027 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000028 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +000031 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000032 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000044</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +000053 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000054<a href="http://www.imagemagick.org/discourse-server/">
55 <img src="../../images/logo.jpg" alt=""
cristy178edaf2011-01-23 03:42:39 +000056 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000057<a href="../../index.html">
58 <img src="../../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
cristyce69bb02010-07-27 19:49:46 +000062<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000063
cristy3ed852e2009-09-05 21:47:34 +000064<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000065 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000066</div>
cristy3eaa0ef2010-03-06 20:35:26 +000067<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000068<div class="menu">
cristybb503372010-05-27 20:51:26 +000069 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000082 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000083</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000085 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000086</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000088 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000089</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000091 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000092</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000094 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000095</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000098</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000106 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000110 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000113 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristybb503372010-05-27 20:51:26 +0000121<div class="menu">
122 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000125 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000128<div class="menu">
cristy52923442011-01-15 22:54:31 +0000129 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000133 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000136 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000140 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000141
142<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000143<div class="sponsor">
144 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
145</div>
cristyec6b4752011-01-08 03:16:23 +0000146<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000147 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000155<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000156 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
157</div>
158<div class="sponsor">
cristyf7964272011-01-30 03:49:12 +0000159 <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
cristyec6b4752011-01-08 03:16:23 +0000160</div>
cristy3ed852e2009-09-05 21:47:34 +0000161</div>
162</div>
cristyce69bb02010-07-27 19:49:46 +0000163</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000164
cristyce69bb02010-07-27 19:49:46 +0000165<div class="eastbar">
166 <script type="text/javascript">
167 <!--
168 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000169 google_ad_slot = "0574824969";
170 google_ad_width = 160;
171 google_ad_height = 600;
172 //-->
173 </script>
174 <script type="text/javascript"
175 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
176 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000177</div>
178
179<div class="main">
180
cristy307ba182010-12-25 01:00:34 +0000181<h1>Module cache-view
182 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000183<p class="navigation-index">[<a href="#AcquireCacheView">AcquireCacheView</a> &bull; <a href="#CloneCacheView">CloneCacheView</a> &bull; <a href="#DestroyCacheView">DestroyCacheView</a> &bull; <a href="#GetCacheViewColorspace">GetCacheViewColorspace</a> &bull; <a href="#GetCacheViewException">GetCacheViewException</a> &bull; <a href="#GetCacheViewStorageClass">GetCacheViewStorageClass</a> &bull; <a href="#GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a> &bull; <a href="#GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a> &bull; <a href="#GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a> &bull; <a href="#GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a> &bull; <a href="#GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a> &bull; <a href="#GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a> &bull; <a href="#GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a> &bull; <a href="#GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a> &bull; <a href="#GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a> &bull; <a href="#QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a> &bull; <a href="#SetCacheViewStorageClass">SetCacheViewStorageClass</a> &bull; <a href="#SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a> &bull; <a href="#SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a>]</p>
184
cristy7a40ba82011-01-08 20:31:18 +0000185<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
186_8c.html" id="AcquireCacheView">AcquireCacheView</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000187<div class="doc-section">
188
cristy7a40ba82011-01-08 20:31:18 +0000189<p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p>
cristy3ed852e2009-09-05 21:47:34 +0000190
191<p>The format of the AcquireCacheView method is:</p>
192
193<pre class="code">
194 CacheView *AcquireCacheView(const Image *image)
195</pre>
196
cristy7a40ba82011-01-08 20:31:18 +0000197<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000198
199<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000200<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000201
202 </div>
cristy7a40ba82011-01-08 20:31:18 +0000203<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
204_8c.html" id="CloneCacheView">CloneCacheView</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000205<div class="doc-section">
206
cristy7a40ba82011-01-08 20:31:18 +0000207<p>CloneCacheView() makes an exact copy of the specified cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000208
209<p>The format of the CloneCacheView method is:</p>
210
211<pre class="code">
212 CacheView *CloneCacheView(const CacheView *cache_view)
213</pre>
214
cristy7a40ba82011-01-08 20:31:18 +0000215<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000216
217<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000218<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000219
220 </div>
cristy7a40ba82011-01-08 20:31:18 +0000221<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
222_8c.html" id="DestroyCacheView">DestroyCacheView</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000223<div class="doc-section">
224
cristy7a40ba82011-01-08 20:31:18 +0000225<p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p>
cristy3ed852e2009-09-05 21:47:34 +0000226
227<p>The format of the DestroyCacheView method is:</p>
228
229<pre class="code">
230 CacheView *DestroyCacheView(CacheView *cache_view)
231</pre>
232
cristy7a40ba82011-01-08 20:31:18 +0000233<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000234
235<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000236<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000237
238 </div>
cristy7a40ba82011-01-08 20:31:18 +0000239<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
240_8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000241<div class="doc-section">
242
cristy7a40ba82011-01-08 20:31:18 +0000243<p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000244
245<p>The format of the GetCacheViewColorspace method is:</p>
246
247<pre class="code">
248 ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
249</pre>
250
cristy7a40ba82011-01-08 20:31:18 +0000251<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000252
253<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000254<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000255
256 </div>
cristy7a40ba82011-01-08 20:31:18 +0000257<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
258_8c.html" id="GetCacheViewException">GetCacheViewException</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000259<div class="doc-section">
260
cristy7a40ba82011-01-08 20:31:18 +0000261<p>GetCacheViewException() returns the image exception associated with the specified view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000262
263<p>The format of the GetCacheViewException method is:</p>
264
265<pre class="code">
266 ExceptionInfo GetCacheViewException(const CacheView *cache_view)
267</pre>
268
cristy7a40ba82011-01-08 20:31:18 +0000269<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000270
271<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000272<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000273
274 </div>
cristy7a40ba82011-01-08 20:31:18 +0000275<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
276_8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000277<div class="doc-section">
278
cristy7a40ba82011-01-08 20:31:18 +0000279<p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000280
281<p>The format of the GetCacheViewStorageClass method is:</p>
282
283<pre class="code">
284 ClassType GetCacheViewStorageClass(const CacheView *cache_view)
285</pre>
286
cristy7a40ba82011-01-08 20:31:18 +0000287<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000288
289<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000290<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000291
292 </div>
cristy7a40ba82011-01-08 20:31:18 +0000293<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
294_8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000295<div class="doc-section">
296
cristy7a40ba82011-01-08 20:31:18 +0000297<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>
cristy3ed852e2009-09-05 21:47:34 +0000298
299<p>The format of the GetCacheViewAuthenticPixels method is:</p>
300
301<pre class="code">
302 PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000303 const ssize_t x,const ssize_t y,const size_t columns,
304 const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000305</pre>
306
cristy7a40ba82011-01-08 20:31:18 +0000307<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000308
309<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000310<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000311
312<h5>x,y,columns,rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000313<p>These values define the perimeter of a region of pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000314
315 </div>
cristy7a40ba82011-01-08 20:31:18 +0000316<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
317_8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000318<div class="doc-section">
319
cristy7a40ba82011-01-08 20:31:18 +0000320<p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p>
cristy3ed852e2009-09-05 21:47:34 +0000321
322<p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
323
324<pre class="code">
325 MagickBooleaNType GetOneCacheViewAuthenticPixel(
cristybb503372010-05-27 20:51:26 +0000326 const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristy3ed852e2009-09-05 21:47:34 +0000327 Pixelpacket *pixel,ExceptionInfo *exception)
328</pre>
329
cristy7a40ba82011-01-08 20:31:18 +0000330<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000331
332<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000333<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000334
335<h5>x,y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000336<p>These values define the offset of the pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000337
338<h5>pixel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000339<p>return a pixel at the specified (x,y) location.</p>
cristy3ed852e2009-09-05 21:47:34 +0000340
341<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000342<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000343
344 </div>
cristy7a40ba82011-01-08 20:31:18 +0000345<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
346_8c.html" id="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000347<div class="doc-section">
348
cristy7a40ba82011-01-08 20:31:18 +0000349<p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.</p>
cristy3ed852e2009-09-05 21:47:34 +0000350
351<p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
352
353<pre class="code">
354 IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
355</pre>
356
cristy7a40ba82011-01-08 20:31:18 +0000357<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000358
359<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000360<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000361
362 </div>
cristy7a40ba82011-01-08 20:31:18 +0000363<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
364_8c.html" id="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000365<div class="doc-section">
366
cristy7a40ba82011-01-08 20:31:18 +0000367<p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be updated.</p>
cristy3ed852e2009-09-05 21:47:34 +0000368
369<p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
370
371<pre class="code">
372 PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
373</pre>
374
cristy7a40ba82011-01-08 20:31:18 +0000375<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000376
377<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000378<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000379
380 </div>
cristy7a40ba82011-01-08 20:31:18 +0000381<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
382_8c.html" id="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000383<div class="doc-section">
384
cristy7a40ba82011-01-08 20:31:18 +0000385<p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.</p>
cristy3ed852e2009-09-05 21:47:34 +0000386
387<p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
388
389<pre class="code">
390 const IndexPacket *GetCacheViewVirtualIndexQueue(
391 const CacheView *cache_view)
392</pre>
393
cristy7a40ba82011-01-08 20:31:18 +0000394<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000395
396<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000397<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000398
399 </div>
cristy7a40ba82011-01-08 20:31:18 +0000400<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
401_8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000402<div class="doc-section">
403
cristy7a40ba82011-01-08 20:31:18 +0000404<p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p>
cristy3ed852e2009-09-05 21:47:34 +0000405
406<p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
407
408<pre class="code">
409 const PixelPacket *GetCacheViewVirtualPixelQueue(
410 const CacheView *cache_view)
411</pre>
412
cristy7a40ba82011-01-08 20:31:18 +0000413<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000414
415<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000416<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000417
418 </div>
cristy7a40ba82011-01-08 20:31:18 +0000419<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
420_8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000421<div class="doc-section">
422
cristy7a40ba82011-01-08 20:31:18 +0000423<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>
cristy3ed852e2009-09-05 21:47:34 +0000424
425<p>The format of the GetCacheViewVirtualPixels method is:</p>
426
427<pre class="code">
428 const PixelPacket *GetCacheViewVirtualPixels(
cristybb503372010-05-27 20:51:26 +0000429 const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristybc9539a2010-08-16 18:06:20 +0000430 const size_t columns,const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000431</pre>
432
cristy7a40ba82011-01-08 20:31:18 +0000433<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000434
435<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000436<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000437
438<h5>x,y,columns,rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000439<p>These values define the perimeter of a region of pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000440
441<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000442<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000443
444 </div>
cristy7a40ba82011-01-08 20:31:18 +0000445<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
446_8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000447<div class="doc-section">
448
cristy7a40ba82011-01-08 20:31:18 +0000449<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>
cristy3ed852e2009-09-05 21:47:34 +0000450
451<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
452
453<pre class="code">
454 MagickBooleanType GetOneCacheViewVirtualPixel(
cristybb503372010-05-27 20:51:26 +0000455 const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristy3ed852e2009-09-05 21:47:34 +0000456 PixelPacket *pixel,ExceptionInfo *exception)
457</pre>
458
cristy7a40ba82011-01-08 20:31:18 +0000459<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000460
461<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000462<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000463
464<h5>x,y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000465<p>These values define the offset of the pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000466
467<h5>pixel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000468<p>return a pixel at the specified (x,y) location.</p>
cristy3ed852e2009-09-05 21:47:34 +0000469
470<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000471<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000472
473 </div>
cristy7a40ba82011-01-08 20:31:18 +0000474<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
475_8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000476<div class="doc-section">
477
cristy7a40ba82011-01-08 20:31:18 +0000478<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>
cristy3ed852e2009-09-05 21:47:34 +0000479
480<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
481
482<pre class="code">
483 MagickBooleanType GetOneCacheViewVirtualMethodPixel(
484 const CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000485 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
486 const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000487</pre>
488
cristy7a40ba82011-01-08 20:31:18 +0000489<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000490
491<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000492<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000493
494<h5>virtual_pixel_method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000495<p>the virtual pixel method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000496
497<h5>x,y</h5>
cristy7a40ba82011-01-08 20:31:18 +0000498<p>These values define the offset of the pixel.</p>
cristy3ed852e2009-09-05 21:47:34 +0000499
500<h5>pixel</h5>
cristy7a40ba82011-01-08 20:31:18 +0000501<p>return a pixel at the specified (x,y) location.</p>
cristy3ed852e2009-09-05 21:47:34 +0000502
503<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000504<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000505
506 </div>
cristy7a40ba82011-01-08 20:31:18 +0000507<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
508_8c.html" id="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000509<div class="doc-section">
510
cristy7a40ba82011-01-08 20:31:18 +0000511<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>
cristy3ed852e2009-09-05 21:47:34 +0000512
513<p>The format of the QueueCacheViewAuthenticPixels method is:</p>
514
515<pre class="code">
516 PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000517 const ssize_t x,const ssize_t y,const size_t columns,
518 const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000519</pre>
520
cristy7a40ba82011-01-08 20:31:18 +0000521<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000522
523<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000524<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000525
526<h5>x,y,columns,rows</h5>
cristy7a40ba82011-01-08 20:31:18 +0000527<p>These values define the perimeter of a region of pixels.</p>
cristy3ed852e2009-09-05 21:47:34 +0000528
529<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000530<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000531
532 </div>
cristy7a40ba82011-01-08 20:31:18 +0000533<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
534_8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000535<div class="doc-section">
536
cristy7a40ba82011-01-08 20:31:18 +0000537<p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000538
539<p>The format of the SetCacheViewStorageClass method is:</p>
540
541<pre class="code">
542 MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
543 const ClassType storage_class)
544</pre>
545
cristy7a40ba82011-01-08 20:31:18 +0000546<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000547
548<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000549<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000550
551<h5>storage_class</h5>
cristy7a40ba82011-01-08 20:31:18 +0000552<p>the image storage class: PseudoClass or DirectClass.</p>
cristy3ed852e2009-09-05 21:47:34 +0000553
554 </div>
cristy7a40ba82011-01-08 20:31:18 +0000555<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
556_8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000557<div class="doc-section">
558
cristy7a40ba82011-01-08 20:31:18 +0000559<p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000560
561<p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
562
563<pre class="code">
564 MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
565 const VirtualPixelMethod virtual_pixel_method)
566</pre>
567
cristy7a40ba82011-01-08 20:31:18 +0000568<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000569
570<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000571<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000572
573<h5>virtual_pixel_method</h5>
cristy7a40ba82011-01-08 20:31:18 +0000574<p>the virtual pixel method.</p>
cristy3ed852e2009-09-05 21:47:34 +0000575
576 </div>
cristy7a40ba82011-01-08 20:31:18 +0000577<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view
578_8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000579<div class="doc-section">
580
cristy7a40ba82011-01-08 20:31:18 +0000581<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>
cristy3ed852e2009-09-05 21:47:34 +0000582
583<p>The format of the SyncCacheViewAuthenticPixels method is:</p>
584
585<pre class="code">
586 MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
587 ExceptionInfo *exception)
588</pre>
589
cristy7a40ba82011-01-08 20:31:18 +0000590<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000591
592<h5>cache_view</h5>
cristy7a40ba82011-01-08 20:31:18 +0000593<p>the cache view.</p>
cristy3ed852e2009-09-05 21:47:34 +0000594
595<h5>exception</h5>
cristy7a40ba82011-01-08 20:31:18 +0000596<p>return any errors or warnings in this structure.</p>
cristy3ed852e2009-09-05 21:47:34 +0000597
598 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000599
600</div>
601
602<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000603 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000604 <span id="linkbar-center">
605 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000606 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000607 </span>
608 <span id="linkbar-east">&nbsp;</span>
609 </div>
610 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000611 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000612 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
613 </div>
614 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000615 <script type="text/javascript">
616 var _gaq = _gaq || [];
617 _gaq.push(['_setAccount', 'UA-17690367-1']);
618 _gaq.push(['_trackPageview']);
619
620 (function() {
621 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
622 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
623 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
624 })();
625 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000626</body>
627</html>