Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / ec6b475b2dcc5fa0e8ecbdc6ffa261abf2e2c268 / . / www / api / cache-view.html
blob: 3742e9fe04b963af7a5257f0b3a6aa21ace0c454 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!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 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <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 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]12 <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 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <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 +0000[diff] [blame]16 <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 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]25 <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"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]30 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]31 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
32 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
33 <script type="text/javascript">
34 $(document).ready(function() {
35 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
36 'transitionIn' : 'elastic',
37 'transitionOut' : 'elastic',
38 'overlayShow' : false,
39 'opacity' : true
40 });
41 });
42 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]43</head>
44
45<body id="www-imagemagick-org">
46<div class="titlebar">
47<a href="../../index.html">
48 <img src="../../images/script.png" alt="[ImageMagick]"
49 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
50<a href="http://www.networkredux.com">
51 <img src="../../images/networkredux.png" alt="[sponsor]"
52 style="margin: 45px auto; border: 0px; float: left;" /></a>
53<a href="http://www.imagemagick.org/discourse-server/">
54 <img src="../../images/logo.jpg" alt=""
55 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
56<a href="../../index.html">
57 <img src="../../images/sprite.jpg" alt=""
58 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
59</div>
60
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]61<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]62
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]63<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]64 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]65</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]66<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]67<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]68 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
69</div>
70<div class="sub">
71 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
72</div>
73<div class="sub">
74 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
75</div>
76<div class="sub">
77 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
78</div>
79<div class="sep"></div>
80<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]81 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82</div>
83<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]84 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]85</div>
86<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]87 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]88</div>
89<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]90 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]91</div>
92<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]105 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]107<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]108<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]109 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110</div>
111<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
114<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116 </div>
117<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]118 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]119</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]120<div class="menu">
121 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
122</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]124 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]126<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]128 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]129</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]130<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]131<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]132 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]133</div>
134<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]135 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]137<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]138<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140
141<div class="sponsbox">
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame^]142<div class="sponsor">
143 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.html">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]144</div>
145<div class="sponsor">
146 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]147</div>
148<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]149 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
150</div>
151<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]152 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
153</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame^]154<div class="sponsor">
155 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
156</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]157</div>
158</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]159</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]160
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]161<div class="eastbar">
162 <script type="text/javascript">
163 <!--
164 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]165 google_ad_slot = "0574824969";
166 google_ad_width = 160;
167 google_ad_height = 600;
168 //-->
169 </script>
170 <script type="text/javascript"
171 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
172 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]173</div>
174
175<div class="main">
176
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]177<h1>Module cache-view
178 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]179<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>
180
181<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
182_8c.html" target="source" name="AcquireCacheView">AcquireCacheView</a></h2>
183<div class="doc-section">
184
185<p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
186
187<p>The format of the AcquireCacheView method is:</p>
188
189<pre class="code">
190 CacheView *AcquireCacheView(const Image *image)
191</pre>
192
193<p>A description of each parameter follows:</p></ol>
194
195<h5>image</h5>
196<ol><p>the image.</p></ol>
197
198 </div>
199<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
200_8c.html" target="source" name="CloneCacheView">CloneCacheView</a></h2>
201<div class="doc-section">
202
203<p>CloneCacheView() makes an exact copy of the specified cache view.</p></ol>
204
205<p>The format of the CloneCacheView method is:</p>
206
207<pre class="code">
208 CacheView *CloneCacheView(const CacheView *cache_view)
209</pre>
210
211<p>A description of each parameter follows:</p></ol>
212
213<h5>cache_view</h5>
214<ol><p>the cache view.</p></ol>
215
216 </div>
217<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
218_8c.html" target="source" name="DestroyCacheView">DestroyCacheView</a></h2>
219<div class="doc-section">
220
221<p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p></ol>
222
223<p>The format of the DestroyCacheView method is:</p>
224
225<pre class="code">
226 CacheView *DestroyCacheView(CacheView *cache_view)
227</pre>
228
229<p>A description of each parameter follows:</p></ol>
230
231<h5>cache_view</h5>
232<ol><p>the cache view.</p></ol>
233
234 </div>
235<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
236_8c.html" target="source" name="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
237<div class="doc-section">
238
239<p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p></ol>
240
241<p>The format of the GetCacheViewColorspace method is:</p>
242
243<pre class="code">
244 ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
245</pre>
246
247<p>A description of each parameter follows:</p></ol>
248
249<h5>cache_view</h5>
250<ol><p>the cache view.</p></ol>
251
252 </div>
253<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
254_8c.html" target="source" name="GetCacheViewException">GetCacheViewException</a></h2>
255<div class="doc-section">
256
257<p>GetCacheViewException() returns the image exception associated with the specified view.</p></ol>
258
259<p>The format of the GetCacheViewException method is:</p>
260
261<pre class="code">
262 ExceptionInfo GetCacheViewException(const CacheView *cache_view)
263</pre>
264
265<p>A description of each parameter follows:</p></ol>
266
267<h5>cache_view</h5>
268<ol><p>the cache view.</p></ol>
269
270 </div>
271<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
272_8c.html" target="source" name="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
273<div class="doc-section">
274
275<p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p></ol>
276
277<p>The format of the GetCacheViewStorageClass method is:</p>
278
279<pre class="code">
280 ClassType GetCacheViewStorageClass(const CacheView *cache_view)
281</pre>
282
283<p>A description of each parameter follows:</p></ol>
284
285<h5>cache_view</h5>
286<ol><p>the cache view.</p></ol>
287
288 </div>
289<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
290_8c.html" target="source" name="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
291<div class="doc-section">
292
293<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></ol>
294
295<p>The format of the GetCacheViewAuthenticPixels method is:</p>
296
297<pre class="code">
298 PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]299 const ssize_t x,const ssize_t y,const size_t columns,
300 const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]301</pre>
302
303<p>A description of each parameter follows:</p></ol>
304
305<h5>cache_view</h5>
306<ol><p>the cache view.</p></ol>
307
308<h5>x,y,columns,rows</h5>
309<ol><p>These values define the perimeter of a region of pixels.</p></ol>
310
311 </div>
312<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
313_8c.html" target="source" name="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
314<div class="doc-section">
315
316<p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
317
318<p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
319
320<pre class="code">
321 MagickBooleaNType GetOneCacheViewAuthenticPixel(
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]322 const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]323 Pixelpacket *pixel,ExceptionInfo *exception)
324</pre>
325
326<p>A description of each parameter follows:</p></ol>
327
328<h5>cache_view</h5>
329<ol><p>the cache view.</p></ol>
330
331<h5>x,y</h5>
332<ol><p>These values define the offset of the pixel.</p></ol>
333
334<h5>pixel</h5>
335<ol><p>return a pixel at the specified (x,y) location.</p></ol>
336
337<h5>exception</h5>
338<ol><p>return any errors or warnings in this structure.</p></ol>
339
340 </div>
341<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
342_8c.html" target="source" name="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
343<div class="doc-section">
344
345<p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.</p></ol>
346
347<p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
348
349<pre class="code">
350 IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
351</pre>
352
353<p>A description of each parameter follows:</p></ol>
354
355<h5>cache_view</h5>
356<ol><p>the cache view.</p></ol>
357
358 </div>
359<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
360_8c.html" target="source" name="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
361<div class="doc-section">
362
363<p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be updated.</p></ol>
364
365<p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
366
367<pre class="code">
368 PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
369</pre>
370
371<p>A description of each parameter follows:</p></ol>
372
373<h5>cache_view</h5>
374<ol><p>the cache view.</p></ol>
375
376 </div>
377<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
378_8c.html" target="source" name="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
379<div class="doc-section">
380
381<p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.</p></ol>
382
383<p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
384
385<pre class="code">
386 const IndexPacket *GetCacheViewVirtualIndexQueue(
387 const CacheView *cache_view)
388</pre>
389
390<p>A description of each parameter follows:</p></ol>
391
392<h5>cache_view</h5>
393<ol><p>the cache view.</p></ol>
394
395 </div>
396<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
397_8c.html" target="source" name="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
398<div class="doc-section">
399
400<p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p></ol>
401
402<p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
403
404<pre class="code">
405 const PixelPacket *GetCacheViewVirtualPixelQueue(
406 const CacheView *cache_view)
407</pre>
408
409<p>A description of each parameter follows:</p></ol>
410
411<h5>cache_view</h5>
412<ol><p>the cache view.</p></ol>
413
414 </div>
415<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
416_8c.html" target="source" name="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
417<div class="doc-section">
418
419<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></ol>
420
421<p>The format of the GetCacheViewVirtualPixels method is:</p>
422
423<pre class="code">
424 const PixelPacket *GetCacheViewVirtualPixels(
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]425 const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristybc9539a2010-08-16 18:06:20 +0000[diff] [blame]426 const size_t columns,const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]427</pre>
428
429<p>A description of each parameter follows:</p></ol>
430
431<h5>cache_view</h5>
432<ol><p>the cache view.</p></ol>
433
434<h5>x,y,columns,rows</h5>
435<ol><p>These values define the perimeter of a region of pixels.</p></ol>
436
437<h5>exception</h5>
438<ol><p>return any errors or warnings in this structure.</p></ol>
439
440 </div>
441<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
442_8c.html" target="source" name="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
443<div class="doc-section">
444
445<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></ol>
446
447<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
448
449<pre class="code">
450 MagickBooleanType GetOneCacheViewVirtualPixel(
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]451 const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]452 PixelPacket *pixel,ExceptionInfo *exception)
453</pre>
454
455<p>A description of each parameter follows:</p></ol>
456
457<h5>cache_view</h5>
458<ol><p>the cache view.</p></ol>
459
460<h5>x,y</h5>
461<ol><p>These values define the offset of the pixel.</p></ol>
462
463<h5>pixel</h5>
464<ol><p>return a pixel at the specified (x,y) location.</p></ol>
465
466<h5>exception</h5>
467<ol><p>return any errors or warnings in this structure.</p></ol>
468
469 </div>
470<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
471_8c.html" target="source" name="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
472<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></ol>
475
476<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
477
478<pre class="code">
479 MagickBooleanType GetOneCacheViewVirtualMethodPixel(
480 const CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]481 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
482 const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]483</pre>
484
485<p>A description of each parameter follows:</p></ol>
486
487<h5>cache_view</h5>
488<ol><p>the cache view.</p></ol>
489
490<h5>virtual_pixel_method</h5>
491<ol><p>the virtual pixel method.</p></ol>
492
493<h5>x,y</h5>
494<ol><p>These values define the offset of the pixel.</p></ol>
495
496<h5>pixel</h5>
497<ol><p>return a pixel at the specified (x,y) location.</p></ol>
498
499<h5>exception</h5>
500<ol><p>return any errors or warnings in this structure.</p></ol>
501
502 </div>
503<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
504_8c.html" target="source" name="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
505<div class="doc-section">
506
507<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></ol>
508
509<p>The format of the QueueCacheViewAuthenticPixels method is:</p>
510
511<pre class="code">
512 PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]513 const ssize_t x,const ssize_t y,const size_t columns,
514 const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]515</pre>
516
517<p>A description of each parameter follows:</p></ol>
518
519<h5>cache_view</h5>
520<ol><p>the cache view.</p></ol>
521
522<h5>x,y,columns,rows</h5>
523<ol><p>These values define the perimeter of a region of pixels.</p></ol>
524
525<h5>exception</h5>
526<ol><p>return any errors or warnings in this structure.</p></ol>
527
528 </div>
529<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
530_8c.html" target="source" name="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
531<div class="doc-section">
532
533<p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p></ol>
534
535<p>The format of the SetCacheViewStorageClass method is:</p>
536
537<pre class="code">
538 MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
539 const ClassType storage_class)
540</pre>
541
542<p>A description of each parameter follows:</p></ol>
543
544<h5>cache_view</h5>
545<ol><p>the cache view.</p></ol>
546
547<h5>storage_class</h5>
548<ol><p>the image storage class: PseudoClass or DirectClass.</p></ol>
549
550 </div>
551<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
552_8c.html" target="source" name="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
553<div class="doc-section">
554
555<p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p></ol>
556
557<p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
558
559<pre class="code">
560 MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
561 const VirtualPixelMethod virtual_pixel_method)
562</pre>
563
564<p>A description of each parameter follows:</p></ol>
565
566<h5>cache_view</h5>
567<ol><p>the cache view.</p></ol>
568
569<h5>virtual_pixel_method</h5>
570<ol><p>the virtual pixel method.</p></ol>
571
572 </div>
573<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
574_8c.html" target="source" name="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
575<div class="doc-section">
576
577<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></ol>
578
579<p>The format of the SyncCacheViewAuthenticPixels method is:</p>
580
581<pre class="code">
582 MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
583 ExceptionInfo *exception)
584</pre>
585
586<p>A description of each parameter follows:</p></ol>
587
588<h5>cache_view</h5>
589<ol><p>the cache view.</p></ol>
590
591<h5>exception</h5>
592<ol><p>return any errors or warnings in this structure.</p></ol>
593
594 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]595
596</div>
597
598<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]599 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]600 <span id="linkbar-center">
601 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]602 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]603 </span>
604 <span id="linkbar-east">&nbsp;</span>
605 </div>
606 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]607 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]608 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
609 </div>
610 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]611 <script type="text/javascript">
612 var _gaq = _gaq || [];
613 _gaq.push(['_setAccount', 'UA-17690367-1']);
614 _gaq.push(['_trackPageview']);
615
616 (function() {
617 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
618 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
619 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
620 })();
621 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]622</body>
623</html>