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