blob: 1ddc8bb753ebc1659864d15fb94c8b23e4c50c8f [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">
cristy2bd2a982011-02-15 00:52:58 +00003<html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy3eaa0ef2010-03-06 20:35:26 +00008<head>
cristy3c98a4f2010-08-13 20:09:41 +00009 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +000011 <title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title>
cristy3ed852e2009-09-05 21:47:34 +000012 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000015 <meta name="Application-name" content="ImageMagick"/>
cristyaf8d6652011-02-04 21:57:45 +000016 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000017 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000018 <meta name="Generator" content="PHP"/>
19 <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 +000020 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +000026 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000027 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +000028 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +000029 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +000031 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +000032 <style type="text/css" media="all">
33 @import url("../../www/magick.css");
34 </style>
cristydcca3fa2010-12-29 21:50:07 +000035 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +000036 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
38 <script type="text/javascript">
39 $(document).ready(function() {
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
41 'transitionIn' : 'elastic',
42 'transitionOut' : 'elastic',
43 'overlayShow' : false,
44 'opacity' : true
45 });
46 });
47 </script>
cristy3eaa0ef2010-03-06 20:35:26 +000048</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
52<a href="../../index.html">
53 <img src="../../images/script.png" alt="[ImageMagick]"
54 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
55<a href="http://www.networkredux.com">
56 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +000057 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000058<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +000059 <img src="../../images/logo.jpg"
60 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +000061 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +000062<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +000063 <img src="../../images/sprite.jpg"
64 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +000065 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
66</div>
67
cristyce69bb02010-07-27 19:49:46 +000068<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000069
cristy3ed852e2009-09-05 21:47:34 +000070<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000072</div>
cristy3eaa0ef2010-03-06 20:35:26 +000073<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000074<div class="menu">
cristybb503372010-05-27 20:51:26 +000075 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
79</div>
80<div class="sub">
81 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
82</div>
83<div class="sub">
84 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
85</div>
86<div class="sep"></div>
87<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000088 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</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: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000092</div>
93<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000094 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000095</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000097 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000098</div>
99<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000100 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000103 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000104</div>
105<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000106 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000107</div>
108<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000109 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000110</div>
111<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000112 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000122 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000123 </div>
124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000125 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000126</div>
cristybb503372010-05-27 20:51:26 +0000127<div class="menu">
128 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
129</div>
cristy3ed852e2009-09-05 21:47:34 +0000130<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000131 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000132</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000133<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000134<div class="menu">
cristy52923442011-01-15 22:54:31 +0000135 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000136</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000137<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000138<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000139 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000140</div>
141<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000142 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000143</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000145<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000146 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000147
148<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000149<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000150 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
151</div>
152<div class="sponsor">
153 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
154</div>
155<div class="sponsor">
cristy2bd2a982011-02-15 00:52:58 +0000156 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
cristy178edaf2011-01-23 03:42:39 +0000157</div>
cristyec6b4752011-01-08 03:16:23 +0000158<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000159 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000160</div>
161<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000162 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
163</div>
164<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000165 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
166</div>
cristyec6b4752011-01-08 03:16:23 +0000167<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000168 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
169</div>
170<div class="sponsor">
cristy350dea42011-02-15 17:31:04 +0000171 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristyec6b4752011-01-08 03:16:23 +0000172</div>
cristy3ed852e2009-09-05 21:47:34 +0000173</div>
174</div>
cristyce69bb02010-07-27 19:49:46 +0000175</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000176
cristyce69bb02010-07-27 19:49:46 +0000177<div class="eastbar">
178 <script type="text/javascript">
179 <!--
180 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000181 google_ad_slot = "0574824969";
182 google_ad_width = 160;
183 google_ad_height = 600;
184 //-->
185 </script>
186 <script type="text/javascript"
187 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
188 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000189</div>
190
191<div class="main">
192
cristy350dea42011-02-15 17:31:04 +0000193<h1>Module cache-view Methods</h1>
cristy6f77f692011-02-15 15:31:39 +0000194<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>
cristy3ed852e2009-09-05 21:47:34 +0000195
cristy350dea42011-02-15 17:31:04 +0000196<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireCacheView">AcquireCacheView</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000197<div class="doc-section">
198
199<p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p>
200
201<p>The format of the AcquireCacheView method is:</p>
202
203<pre class="code">
204 CacheView *AcquireCacheView(const Image *image)
205</pre>
206
207<p>A description of each parameter follows:</p>
208
209<h5>image</h5>
210<p>the image.</p>
211
212 </div>
cristy350dea42011-02-15 17:31:04 +0000213<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="CloneCacheView">CloneCacheView</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000214<div class="doc-section">
215
216<p>CloneCacheView() makes an exact copy of the specified cache view.</p>
217
218<p>The format of the CloneCacheView method is:</p>
219
220<pre class="code">
221 CacheView *CloneCacheView(const CacheView *cache_view)
222</pre>
223
224<p>A description of each parameter follows:</p>
225
226<h5>cache_view</h5>
227<p>the cache view.</p>
228
229 </div>
cristy350dea42011-02-15 17:31:04 +0000230<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="DestroyCacheView">DestroyCacheView</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000231<div class="doc-section">
232
233<p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p>
234
235<p>The format of the DestroyCacheView method is:</p>
236
237<pre class="code">
238 CacheView *DestroyCacheView(CacheView *cache_view)
239</pre>
240
241<p>A description of each parameter follows:</p>
242
243<h5>cache_view</h5>
244<p>the cache view.</p>
245
246 </div>
cristy350dea42011-02-15 17:31:04 +0000247<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000248<div class="doc-section">
249
250<p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p>
251
252<p>The format of the GetCacheViewColorspace method is:</p>
253
254<pre class="code">
255 ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
256</pre>
257
258<p>A description of each parameter follows:</p>
259
260<h5>cache_view</h5>
261<p>the cache view.</p>
262
263 </div>
cristy350dea42011-02-15 17:31:04 +0000264<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewException">GetCacheViewException</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000265<div class="doc-section">
266
267<p>GetCacheViewException() returns the image exception associated with the specified view.</p>
268
269<p>The format of the GetCacheViewException method is:</p>
270
271<pre class="code">
272 ExceptionInfo GetCacheViewException(const CacheView *cache_view)
273</pre>
274
275<p>A description of each parameter follows:</p>
276
277<h5>cache_view</h5>
278<p>the cache view.</p>
279
280 </div>
cristy350dea42011-02-15 17:31:04 +0000281<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000282<div class="doc-section">
283
284<p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p>
285
286<p>The format of the GetCacheViewStorageClass method is:</p>
287
288<pre class="code">
289 ClassType GetCacheViewStorageClass(const CacheView *cache_view)
290</pre>
291
292<p>A description of each parameter follows:</p>
293
294<h5>cache_view</h5>
295<p>the cache view.</p>
296
297 </div>
cristy350dea42011-02-15 17:31:04 +0000298<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000299<div class="doc-section">
300
301<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>
302
303<p>The format of the GetCacheViewAuthenticPixels method is:</p>
304
305<pre class="code">
306 PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
307 const ssize_t x,const ssize_t y,const size_t columns,
308 const size_t rows,ExceptionInfo *exception)
309</pre>
310
311<p>A description of each parameter follows:</p>
312
313<h5>cache_view</h5>
314<p>the cache view.</p>
315
316<h5>x,y,columns,rows</h5>
317<p>These values define the perimeter of a region of pixels.</p>
318
319 </div>
cristy350dea42011-02-15 17:31:04 +0000320<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000321<div class="doc-section">
322
323<p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p>
324
325<p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
326
327<pre class="code">
328 MagickBooleaNType GetOneCacheViewAuthenticPixel(
329 const CacheView *cache_view,const ssize_t x,const ssize_t y,
330 Pixelpacket *pixel,ExceptionInfo *exception)
331</pre>
332
333<p>A description of each parameter follows:</p>
334
335<h5>cache_view</h5>
336<p>the cache view.</p>
337
338<h5>x,y</h5>
339<p>These values define the offset of the pixel.</p>
340
341<h5>pixel</h5>
342<p>return a pixel at the specified (x,y) location.</p>
343
344<h5>exception</h5>
345<p>return any errors or warnings in this structure.</p>
346
347 </div>
cristy350dea42011-02-15 17:31:04 +0000348<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000349<div class="doc-section">
350
351<p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.</p>
352
353<p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
354
355<pre class="code">
356 IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
357</pre>
358
359<p>A description of each parameter follows:</p>
360
361<h5>cache_view</h5>
362<p>the cache view.</p>
363
364 </div>
cristy350dea42011-02-15 17:31:04 +0000365<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000366<div class="doc-section">
367
368<p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be updated.</p>
369
370<p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
371
372<pre class="code">
373 PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
374</pre>
375
376<p>A description of each parameter follows:</p>
377
378<h5>cache_view</h5>
379<p>the cache view.</p>
380
381 </div>
cristy350dea42011-02-15 17:31:04 +0000382<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000383<div class="doc-section">
384
385<p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.</p>
386
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
394<p>A description of each parameter follows:</p>
395
396<h5>cache_view</h5>
397<p>the cache view.</p>
398
399 </div>
cristy350dea42011-02-15 17:31:04 +0000400<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000401<div class="doc-section">
402
403<p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p>
404
405<p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
406
407<pre class="code">
408 const PixelPacket *GetCacheViewVirtualPixelQueue(
409 const CacheView *cache_view)
410</pre>
411
412<p>A description of each parameter follows:</p>
413
414<h5>cache_view</h5>
415<p>the cache view.</p>
416
417 </div>
cristy350dea42011-02-15 17:31:04 +0000418<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000419<div class="doc-section">
420
421<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>
422
423<p>The format of the GetCacheViewVirtualPixels method is:</p>
424
425<pre class="code">
426 const PixelPacket *GetCacheViewVirtualPixels(
427 const CacheView *cache_view,const ssize_t x,const ssize_t y,
428 const size_t columns,const size_t rows,ExceptionInfo *exception)
429</pre>
430
431<p>A description of each parameter follows:</p>
432
433<h5>cache_view</h5>
434<p>the cache view.</p>
435
436<h5>x,y,columns,rows</h5>
437<p>These values define the perimeter of a region of pixels.</p>
438
439<h5>exception</h5>
440<p>return any errors or warnings in this structure.</p>
441
442 </div>
cristy350dea42011-02-15 17:31:04 +0000443<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000444<div class="doc-section">
445
446<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>
447
448<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
449
450<pre class="code">
451 MagickBooleanType GetOneCacheViewVirtualPixel(
452 const CacheView *cache_view,const ssize_t x,const ssize_t y,
453 PixelPacket *pixel,ExceptionInfo *exception)
454</pre>
455
456<p>A description of each parameter follows:</p>
457
458<h5>cache_view</h5>
459<p>the cache view.</p>
460
461<h5>x,y</h5>
462<p>These values define the offset of the pixel.</p>
463
464<h5>pixel</h5>
465<p>return a pixel at the specified (x,y) location.</p>
466
467<h5>exception</h5>
468<p>return any errors or warnings in this structure.</p>
469
470 </div>
cristy350dea42011-02-15 17:31:04 +0000471<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000472<div class="doc-section">
473
474<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>
475
476<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
477
478<pre class="code">
479 MagickBooleanType GetOneCacheViewVirtualMethodPixel(
480 const CacheView *cache_view,
481 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
482 const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
483</pre>
484
485<p>A description of each parameter follows:</p>
486
487<h5>cache_view</h5>
488<p>the cache view.</p>
489
490<h5>virtual_pixel_method</h5>
491<p>the virtual pixel method.</p>
492
493<h5>x,y</h5>
494<p>These values define the offset of the pixel.</p>
495
496<h5>pixel</h5>
497<p>return a pixel at the specified (x,y) location.</p>
498
499<h5>exception</h5>
500<p>return any errors or warnings in this structure.</p>
501
502 </div>
cristy350dea42011-02-15 17:31:04 +0000503<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000504<div class="doc-section">
505
506<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>
507
508<p>The format of the QueueCacheViewAuthenticPixels method is:</p>
509
510<pre class="code">
511 PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
512 const ssize_t x,const ssize_t y,const size_t columns,
513 const size_t rows,ExceptionInfo *exception)
514</pre>
515
516<p>A description of each parameter follows:</p>
517
518<h5>cache_view</h5>
519<p>the cache view.</p>
520
521<h5>x,y,columns,rows</h5>
522<p>These values define the perimeter of a region of pixels.</p>
523
524<h5>exception</h5>
525<p>return any errors or warnings in this structure.</p>
526
527 </div>
cristy350dea42011-02-15 17:31:04 +0000528<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000529<div class="doc-section">
530
531<p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p>
532
533<p>The format of the SetCacheViewStorageClass method is:</p>
534
535<pre class="code">
536 MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
537 const ClassType storage_class)
538</pre>
539
540<p>A description of each parameter follows:</p>
541
542<h5>cache_view</h5>
543<p>the cache view.</p>
544
545<h5>storage_class</h5>
546<p>the image storage class: PseudoClass or DirectClass.</p>
547
548 </div>
cristy350dea42011-02-15 17:31:04 +0000549<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000550<div class="doc-section">
551
552<p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p>
553
554<p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
555
556<pre class="code">
557 MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
558 const VirtualPixelMethod virtual_pixel_method)
559</pre>
560
561<p>A description of each parameter follows:</p>
562
563<h5>cache_view</h5>
564<p>the cache view.</p>
565
566<h5>virtual_pixel_method</h5>
567<p>the virtual pixel method.</p>
568
569 </div>
cristy350dea42011-02-15 17:31:04 +0000570<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000571<div class="doc-section">
572
573<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>
574
575<p>The format of the SyncCacheViewAuthenticPixels method is:</p>
576
577<pre class="code">
578 MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
579 ExceptionInfo *exception)
580</pre>
581
582<p>A description of each parameter follows:</p>
583
584<h5>cache_view</h5>
585<p>the cache view.</p>
586
587<h5>exception</h5>
588<p>return any errors or warnings in this structure.</p>
589
590 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000591
592</div>
593
594<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000595 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000596 <span id="linkbar-center">
597 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000598 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000599 </span>
600 <span id="linkbar-east">&nbsp;</span>
601 </div>
602 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000603 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000604 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
605 </div>
606 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000607 <script type="text/javascript">
608 var _gaq = _gaq || [];
609 _gaq.push(['_setAccount', 'UA-17690367-1']);
610 _gaq.push(['_trackPageview']);
611
612 (function() {
613 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
614 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
615 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
616 })();
617 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000618</body>
619</html>