Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / dcca3fa3bc535a40a90c681bf07f2379fc2f3f76 / . / www / api / cache-view.html
blob: 23c2400eeecc44a9f48e8a33b9ce18d9da0ad8d6 [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>
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">
142<div class="sponsor">
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]143 <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]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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]154</div>
155</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]156</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]157
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]158<div class="eastbar">
159 <script type="text/javascript">
160 <!--
161 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]162 google_ad_slot = "0574824969";
163 google_ad_width = 160;
164 google_ad_height = 600;
165 //-->
166 </script>
167 <script type="text/javascript"
168 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
169 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]170</div>
171
172<div class="main">
173
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]174<h1>Module cache-view
175 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]176<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>
177
178<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
179_8c.html" target="source" name="AcquireCacheView">AcquireCacheView</a></h2>
180<div class="doc-section">
181
182<p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
183
184<p>The format of the AcquireCacheView method is:</p>
185
186<pre class="code">
187 CacheView *AcquireCacheView(const Image *image)
188</pre>
189
190<p>A description of each parameter follows:</p></ol>
191
192<h5>image</h5>
193<ol><p>the image.</p></ol>
194
195 </div>
196<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
197_8c.html" target="source" name="CloneCacheView">CloneCacheView</a></h2>
198<div class="doc-section">
199
200<p>CloneCacheView() makes an exact copy of the specified cache view.</p></ol>
201
202<p>The format of the CloneCacheView method is:</p>
203
204<pre class="code">
205 CacheView *CloneCacheView(const CacheView *cache_view)
206</pre>
207
208<p>A description of each parameter follows:</p></ol>
209
210<h5>cache_view</h5>
211<ol><p>the cache view.</p></ol>
212
213 </div>
214<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
215_8c.html" target="source" name="DestroyCacheView">DestroyCacheView</a></h2>
216<div class="doc-section">
217
218<p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p></ol>
219
220<p>The format of the DestroyCacheView method is:</p>
221
222<pre class="code">
223 CacheView *DestroyCacheView(CacheView *cache_view)
224</pre>
225
226<p>A description of each parameter follows:</p></ol>
227
228<h5>cache_view</h5>
229<ol><p>the cache view.</p></ol>
230
231 </div>
232<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
233_8c.html" target="source" name="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
234<div class="doc-section">
235
236<p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p></ol>
237
238<p>The format of the GetCacheViewColorspace method is:</p>
239
240<pre class="code">
241 ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
242</pre>
243
244<p>A description of each parameter follows:</p></ol>
245
246<h5>cache_view</h5>
247<ol><p>the cache view.</p></ol>
248
249 </div>
250<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
251_8c.html" target="source" name="GetCacheViewException">GetCacheViewException</a></h2>
252<div class="doc-section">
253
254<p>GetCacheViewException() returns the image exception associated with the specified view.</p></ol>
255
256<p>The format of the GetCacheViewException method is:</p>
257
258<pre class="code">
259 ExceptionInfo GetCacheViewException(const CacheView *cache_view)
260</pre>
261
262<p>A description of each parameter follows:</p></ol>
263
264<h5>cache_view</h5>
265<ol><p>the cache view.</p></ol>
266
267 </div>
268<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
269_8c.html" target="source" name="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
270<div class="doc-section">
271
272<p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p></ol>
273
274<p>The format of the GetCacheViewStorageClass method is:</p>
275
276<pre class="code">
277 ClassType GetCacheViewStorageClass(const CacheView *cache_view)
278</pre>
279
280<p>A description of each parameter follows:</p></ol>
281
282<h5>cache_view</h5>
283<ol><p>the cache view.</p></ol>
284
285 </div>
286<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
287_8c.html" target="source" name="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
288<div class="doc-section">
289
290<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>
291
292<p>The format of the GetCacheViewAuthenticPixels method is:</p>
293
294<pre class="code">
295 PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]296 const ssize_t x,const ssize_t y,const size_t columns,
297 const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]298</pre>
299
300<p>A description of each parameter follows:</p></ol>
301
302<h5>cache_view</h5>
303<ol><p>the cache view.</p></ol>
304
305<h5>x,y,columns,rows</h5>
306<ol><p>These values define the perimeter of a region of pixels.</p></ol>
307
308 </div>
309<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
310_8c.html" target="source" name="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
311<div class="doc-section">
312
313<p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
314
315<p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
316
317<pre class="code">
318 MagickBooleaNType GetOneCacheViewAuthenticPixel(
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]319 const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]320 Pixelpacket *pixel,ExceptionInfo *exception)
321</pre>
322
323<p>A description of each parameter follows:</p></ol>
324
325<h5>cache_view</h5>
326<ol><p>the cache view.</p></ol>
327
328<h5>x,y</h5>
329<ol><p>These values define the offset of the pixel.</p></ol>
330
331<h5>pixel</h5>
332<ol><p>return a pixel at the specified (x,y) location.</p></ol>
333
334<h5>exception</h5>
335<ol><p>return any errors or warnings in this structure.</p></ol>
336
337 </div>
338<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
339_8c.html" target="source" name="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
340<div class="doc-section">
341
342<p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.</p></ol>
343
344<p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
345
346<pre class="code">
347 IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
348</pre>
349
350<p>A description of each parameter follows:</p></ol>
351
352<h5>cache_view</h5>
353<ol><p>the cache view.</p></ol>
354
355 </div>
356<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
357_8c.html" target="source" name="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
358<div class="doc-section">
359
360<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>
361
362<p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
363
364<pre class="code">
365 PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
366</pre>
367
368<p>A description of each parameter follows:</p></ol>
369
370<h5>cache_view</h5>
371<ol><p>the cache view.</p></ol>
372
373 </div>
374<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
375_8c.html" target="source" name="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
376<div class="doc-section">
377
378<p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.</p></ol>
379
380<p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
381
382<pre class="code">
383 const IndexPacket *GetCacheViewVirtualIndexQueue(
384 const CacheView *cache_view)
385</pre>
386
387<p>A description of each parameter follows:</p></ol>
388
389<h5>cache_view</h5>
390<ol><p>the cache view.</p></ol>
391
392 </div>
393<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
394_8c.html" target="source" name="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
395<div class="doc-section">
396
397<p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p></ol>
398
399<p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
400
401<pre class="code">
402 const PixelPacket *GetCacheViewVirtualPixelQueue(
403 const CacheView *cache_view)
404</pre>
405
406<p>A description of each parameter follows:</p></ol>
407
408<h5>cache_view</h5>
409<ol><p>the cache view.</p></ol>
410
411 </div>
412<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
413_8c.html" target="source" name="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
414<div class="doc-section">
415
416<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>
417
418<p>The format of the GetCacheViewVirtualPixels method is:</p>
419
420<pre class="code">
421 const PixelPacket *GetCacheViewVirtualPixels(
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]422 const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristybc9539a2010-08-16 18:06:20 +0000[diff] [blame]423 const size_t columns,const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]424</pre>
425
426<p>A description of each parameter follows:</p></ol>
427
428<h5>cache_view</h5>
429<ol><p>the cache view.</p></ol>
430
431<h5>x,y,columns,rows</h5>
432<ol><p>These values define the perimeter of a region of pixels.</p></ol>
433
434<h5>exception</h5>
435<ol><p>return any errors or warnings in this structure.</p></ol>
436
437 </div>
438<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
439_8c.html" target="source" name="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
440<div class="doc-section">
441
442<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>
443
444<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
445
446<pre class="code">
447 MagickBooleanType GetOneCacheViewVirtualPixel(
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]448 const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]449 PixelPacket *pixel,ExceptionInfo *exception)
450</pre>
451
452<p>A description of each parameter follows:</p></ol>
453
454<h5>cache_view</h5>
455<ol><p>the cache view.</p></ol>
456
457<h5>x,y</h5>
458<ol><p>These values define the offset of the pixel.</p></ol>
459
460<h5>pixel</h5>
461<ol><p>return a pixel at the specified (x,y) location.</p></ol>
462
463<h5>exception</h5>
464<ol><p>return any errors or warnings in this structure.</p></ol>
465
466 </div>
467<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
468_8c.html" target="source" name="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
469<div class="doc-section">
470
471<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>
472
473<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
474
475<pre class="code">
476 MagickBooleanType GetOneCacheViewVirtualMethodPixel(
477 const CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]478 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
479 const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]480</pre>
481
482<p>A description of each parameter follows:</p></ol>
483
484<h5>cache_view</h5>
485<ol><p>the cache view.</p></ol>
486
487<h5>virtual_pixel_method</h5>
488<ol><p>the virtual pixel method.</p></ol>
489
490<h5>x,y</h5>
491<ol><p>These values define the offset of the pixel.</p></ol>
492
493<h5>pixel</h5>
494<ol><p>return a pixel at the specified (x,y) location.</p></ol>
495
496<h5>exception</h5>
497<ol><p>return any errors or warnings in this structure.</p></ol>
498
499 </div>
500<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
501_8c.html" target="source" name="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
502<div class="doc-section">
503
504<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>
505
506<p>The format of the QueueCacheViewAuthenticPixels method is:</p>
507
508<pre class="code">
509 PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]510 const ssize_t x,const ssize_t y,const size_t columns,
511 const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]512</pre>
513
514<p>A description of each parameter follows:</p></ol>
515
516<h5>cache_view</h5>
517<ol><p>the cache view.</p></ol>
518
519<h5>x,y,columns,rows</h5>
520<ol><p>These values define the perimeter of a region of pixels.</p></ol>
521
522<h5>exception</h5>
523<ol><p>return any errors or warnings in this structure.</p></ol>
524
525 </div>
526<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
527_8c.html" target="source" name="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
528<div class="doc-section">
529
530<p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p></ol>
531
532<p>The format of the SetCacheViewStorageClass method is:</p>
533
534<pre class="code">
535 MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
536 const ClassType storage_class)
537</pre>
538
539<p>A description of each parameter follows:</p></ol>
540
541<h5>cache_view</h5>
542<ol><p>the cache view.</p></ol>
543
544<h5>storage_class</h5>
545<ol><p>the image storage class: PseudoClass or DirectClass.</p></ol>
546
547 </div>
548<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
549_8c.html" target="source" name="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
550<div class="doc-section">
551
552<p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p></ol>
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></ol>
562
563<h5>cache_view</h5>
564<ol><p>the cache view.</p></ol>
565
566<h5>virtual_pixel_method</h5>
567<ol><p>the virtual pixel method.</p></ol>
568
569 </div>
570<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
571_8c.html" target="source" name="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
572<div class="doc-section">
573
574<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>
575
576<p>The format of the SyncCacheViewAuthenticPixels method is:</p>
577
578<pre class="code">
579 MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
580 ExceptionInfo *exception)
581</pre>
582
583<p>A description of each parameter follows:</p></ol>
584
585<h5>cache_view</h5>
586<ol><p>the cache view.</p></ol>
587
588<h5>exception</h5>
589<ol><p>return any errors or warnings in this structure.</p></ol>
590
591 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]592
593</div>
594
595<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]596 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]597 <span id="linkbar-center">
598 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]599 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]600 </span>
601 <span id="linkbar-east">&nbsp;</span>
602 </div>
603 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]604 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]605 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
606 </div>
607 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]608 <script type="text/javascript">
609 var _gaq = _gaq || [];
610 _gaq.push(['_setAccount', 'UA-17690367-1']);
611 _gaq.push(['_trackPageview']);
612
613 (function() {
614 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
615 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
616 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
617 })();
618 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]619</body>
620</html>