Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / c5baf4f57fb0f9cf582c4b9e699a5fe8b3ae7e7b / . / www / api / cache-view.html
blob: d247f758eaf1a9630da525cad894a2cc002a5948 [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="/>
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"/>
12 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
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"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2010 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">
cristy83a272e2010-05-07 20:40:35 +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">
cristy83a272e2010-05-07 20:40:35 +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">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame^]130 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
131</div>
132<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]133 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <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]137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]140</div>
141<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame^]142 <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]143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]145 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame^]148 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristy3ed852e2009-09-05 21:47:34 +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
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]170<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>
171
172<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
173_8c.html" target="source" name="AcquireCacheView">AcquireCacheView</a></h2>
174<div class="doc-section">
175
176<p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
177
178<p>The format of the AcquireCacheView method is:</p>
179
180<pre class="code">
181 CacheView *AcquireCacheView(const Image *image)
182</pre>
183
184<p>A description of each parameter follows:</p></ol>
185
186<h5>image</h5>
187<ol><p>the image.</p></ol>
188
189 </div>
190<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
191_8c.html" target="source" name="CloneCacheView">CloneCacheView</a></h2>
192<div class="doc-section">
193
194<p>CloneCacheView() makes an exact copy of the specified cache view.</p></ol>
195
196<p>The format of the CloneCacheView method is:</p>
197
198<pre class="code">
199 CacheView *CloneCacheView(const CacheView *cache_view)
200</pre>
201
202<p>A description of each parameter follows:</p></ol>
203
204<h5>cache_view</h5>
205<ol><p>the cache view.</p></ol>
206
207 </div>
208<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
209_8c.html" target="source" name="DestroyCacheView">DestroyCacheView</a></h2>
210<div class="doc-section">
211
212<p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p></ol>
213
214<p>The format of the DestroyCacheView method is:</p>
215
216<pre class="code">
217 CacheView *DestroyCacheView(CacheView *cache_view)
218</pre>
219
220<p>A description of each parameter follows:</p></ol>
221
222<h5>cache_view</h5>
223<ol><p>the cache view.</p></ol>
224
225 </div>
226<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
227_8c.html" target="source" name="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
228<div class="doc-section">
229
230<p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p></ol>
231
232<p>The format of the GetCacheViewColorspace method is:</p>
233
234<pre class="code">
235 ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
236</pre>
237
238<p>A description of each parameter follows:</p></ol>
239
240<h5>cache_view</h5>
241<ol><p>the cache view.</p></ol>
242
243 </div>
244<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
245_8c.html" target="source" name="GetCacheViewException">GetCacheViewException</a></h2>
246<div class="doc-section">
247
248<p>GetCacheViewException() returns the image exception associated with the specified view.</p></ol>
249
250<p>The format of the GetCacheViewException method is:</p>
251
252<pre class="code">
253 ExceptionInfo GetCacheViewException(const CacheView *cache_view)
254</pre>
255
256<p>A description of each parameter follows:</p></ol>
257
258<h5>cache_view</h5>
259<ol><p>the cache view.</p></ol>
260
261 </div>
262<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
263_8c.html" target="source" name="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
264<div class="doc-section">
265
266<p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p></ol>
267
268<p>The format of the GetCacheViewStorageClass method is:</p>
269
270<pre class="code">
271 ClassType GetCacheViewStorageClass(const CacheView *cache_view)
272</pre>
273
274<p>A description of each parameter follows:</p></ol>
275
276<h5>cache_view</h5>
277<ol><p>the cache view.</p></ol>
278
279 </div>
280<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
281_8c.html" target="source" name="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
282<div class="doc-section">
283
284<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>
285
286<p>The format of the GetCacheViewAuthenticPixels method is:</p>
287
288<pre class="code">
289 PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]290 const ssize_t x,const ssize_t y,const size_t columns,
291 const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]292</pre>
293
294<p>A description of each parameter follows:</p></ol>
295
296<h5>cache_view</h5>
297<ol><p>the cache view.</p></ol>
298
299<h5>x,y,columns,rows</h5>
300<ol><p>These values define the perimeter of a region of pixels.</p></ol>
301
302 </div>
303<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
304_8c.html" target="source" name="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
305<div class="doc-section">
306
307<p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
308
309<p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
310
311<pre class="code">
312 MagickBooleaNType GetOneCacheViewAuthenticPixel(
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]313 const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]314 Pixelpacket *pixel,ExceptionInfo *exception)
315</pre>
316
317<p>A description of each parameter follows:</p></ol>
318
319<h5>cache_view</h5>
320<ol><p>the cache view.</p></ol>
321
322<h5>x,y</h5>
323<ol><p>These values define the offset of the pixel.</p></ol>
324
325<h5>pixel</h5>
326<ol><p>return a pixel at the specified (x,y) location.</p></ol>
327
328<h5>exception</h5>
329<ol><p>return any errors or warnings in this structure.</p></ol>
330
331 </div>
332<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
333_8c.html" target="source" name="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
334<div class="doc-section">
335
336<p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.</p></ol>
337
338<p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
339
340<pre class="code">
341 IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
342</pre>
343
344<p>A description of each parameter follows:</p></ol>
345
346<h5>cache_view</h5>
347<ol><p>the cache view.</p></ol>
348
349 </div>
350<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
351_8c.html" target="source" name="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
352<div class="doc-section">
353
354<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>
355
356<p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
357
358<pre class="code">
359 PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
360</pre>
361
362<p>A description of each parameter follows:</p></ol>
363
364<h5>cache_view</h5>
365<ol><p>the cache view.</p></ol>
366
367 </div>
368<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
369_8c.html" target="source" name="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
370<div class="doc-section">
371
372<p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.</p></ol>
373
374<p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
375
376<pre class="code">
377 const IndexPacket *GetCacheViewVirtualIndexQueue(
378 const CacheView *cache_view)
379</pre>
380
381<p>A description of each parameter follows:</p></ol>
382
383<h5>cache_view</h5>
384<ol><p>the cache view.</p></ol>
385
386 </div>
387<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
388_8c.html" target="source" name="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
389<div class="doc-section">
390
391<p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p></ol>
392
393<p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
394
395<pre class="code">
396 const PixelPacket *GetCacheViewVirtualPixelQueue(
397 const CacheView *cache_view)
398</pre>
399
400<p>A description of each parameter follows:</p></ol>
401
402<h5>cache_view</h5>
403<ol><p>the cache view.</p></ol>
404
405 </div>
406<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
407_8c.html" target="source" name="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
408<div class="doc-section">
409
410<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>
411
412<p>The format of the GetCacheViewVirtualPixels method is:</p>
413
414<pre class="code">
415 const PixelPacket *GetCacheViewVirtualPixels(
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]416 const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristybc9539a2010-08-16 18:06:20 +0000[diff] [blame]417 const size_t columns,const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]418</pre>
419
420<p>A description of each parameter follows:</p></ol>
421
422<h5>cache_view</h5>
423<ol><p>the cache view.</p></ol>
424
425<h5>x,y,columns,rows</h5>
426<ol><p>These values define the perimeter of a region of pixels.</p></ol>
427
428<h5>exception</h5>
429<ol><p>return any errors or warnings in this structure.</p></ol>
430
431 </div>
432<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
433_8c.html" target="source" name="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
434<div class="doc-section">
435
436<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>
437
438<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
439
440<pre class="code">
441 MagickBooleanType GetOneCacheViewVirtualPixel(
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]442 const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]443 PixelPacket *pixel,ExceptionInfo *exception)
444</pre>
445
446<p>A description of each parameter follows:</p></ol>
447
448<h5>cache_view</h5>
449<ol><p>the cache view.</p></ol>
450
451<h5>x,y</h5>
452<ol><p>These values define the offset of the pixel.</p></ol>
453
454<h5>pixel</h5>
455<ol><p>return a pixel at the specified (x,y) location.</p></ol>
456
457<h5>exception</h5>
458<ol><p>return any errors or warnings in this structure.</p></ol>
459
460 </div>
461<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
462_8c.html" target="source" name="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
463<div class="doc-section">
464
465<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>
466
467<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
468
469<pre class="code">
470 MagickBooleanType GetOneCacheViewVirtualMethodPixel(
471 const CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]472 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
473 const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]474</pre>
475
476<p>A description of each parameter follows:</p></ol>
477
478<h5>cache_view</h5>
479<ol><p>the cache view.</p></ol>
480
481<h5>virtual_pixel_method</h5>
482<ol><p>the virtual pixel method.</p></ol>
483
484<h5>x,y</h5>
485<ol><p>These values define the offset of the pixel.</p></ol>
486
487<h5>pixel</h5>
488<ol><p>return a pixel at the specified (x,y) location.</p></ol>
489
490<h5>exception</h5>
491<ol><p>return any errors or warnings in this structure.</p></ol>
492
493 </div>
494<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
495_8c.html" target="source" name="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
496<div class="doc-section">
497
498<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>
499
500<p>The format of the QueueCacheViewAuthenticPixels method is:</p>
501
502<pre class="code">
503 PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]504 const ssize_t x,const ssize_t y,const size_t columns,
505 const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]506</pre>
507
508<p>A description of each parameter follows:</p></ol>
509
510<h5>cache_view</h5>
511<ol><p>the cache view.</p></ol>
512
513<h5>x,y,columns,rows</h5>
514<ol><p>These values define the perimeter of a region of pixels.</p></ol>
515
516<h5>exception</h5>
517<ol><p>return any errors or warnings in this structure.</p></ol>
518
519 </div>
520<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
521_8c.html" target="source" name="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
522<div class="doc-section">
523
524<p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p></ol>
525
526<p>The format of the SetCacheViewStorageClass method is:</p>
527
528<pre class="code">
529 MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
530 const ClassType storage_class)
531</pre>
532
533<p>A description of each parameter follows:</p></ol>
534
535<h5>cache_view</h5>
536<ol><p>the cache view.</p></ol>
537
538<h5>storage_class</h5>
539<ol><p>the image storage class: PseudoClass or DirectClass.</p></ol>
540
541 </div>
542<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
543_8c.html" target="source" name="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
544<div class="doc-section">
545
546<p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p></ol>
547
548<p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
549
550<pre class="code">
551 MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
552 const VirtualPixelMethod virtual_pixel_method)
553</pre>
554
555<p>A description of each parameter follows:</p></ol>
556
557<h5>cache_view</h5>
558<ol><p>the cache view.</p></ol>
559
560<h5>virtual_pixel_method</h5>
561<ol><p>the virtual pixel method.</p></ol>
562
563 </div>
564<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
565_8c.html" target="source" name="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
566<div class="doc-section">
567
568<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>
569
570<p>The format of the SyncCacheViewAuthenticPixels method is:</p>
571
572<pre class="code">
573 MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
574 ExceptionInfo *exception)
575</pre>
576
577<p>A description of each parameter follows:</p></ol>
578
579<h5>cache_view</h5>
580<ol><p>the cache view.</p></ol>
581
582<h5>exception</h5>
583<ol><p>return any errors or warnings in this structure.</p></ol>
584
585 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]586
587</div>
588
589<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]590 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]591 <span id="linkbar-center">
592 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]593 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]594 </span>
595 <span id="linkbar-east">&nbsp;</span>
596 </div>
597 <div class="footer">
598 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
599 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
600 </div>
601 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]602 <script type="text/javascript">
603 var _gaq = _gaq || [];
604 _gaq.push(['_setAccount', 'UA-17690367-1']);
605 _gaq.push(['_trackPageview']);
606
607 (function() {
608 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
609 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
610 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
611 })();
612 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]613</body>
614</html>