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