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