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