Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / dba8f1d76edeaf76dc224808eeb341967748ee1b / . / www / api / cache-view.html
blob: 7dbed290a0699c6b6d4e55d4d71e36b3fae12bc9 [file] [log] [blame]
cristy06f63f22012-10-31 00: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 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">
8<head>
9 <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]10 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]11 <title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title>
cristy751980d2012-06-03 23:18:35 +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"/>
15 <meta name="application-name" content="ImageMagick"/>
cristy8ee7f242013-06-20 16:08:44 +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 or transform images automagically."/>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]17 <meta name="application-url" content="http://www.imagemagick.org"/>
18 <meta name="generator" content="PHP"/>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]19 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, cache, views, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
cristy751980d2012-06-03 23:18:35 +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"/>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]26 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]27 <meta name="distribution" content="Global"/>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]28 <link rel="icon" href="../../images/wand.png"/>
29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]30 <link rel="canonical" href="http://www.imagemagick.org" />
31 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]32
33 <!-- Add jQuery library -->
34 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
35
36 <!-- Add mousewheel plugin (this is optional) -->
37 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
38
39 <!-- Add fancyBox -->
40 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen" />
41 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
42
43 <!-- Optionally add helpers - button, thumbnail and/or media -->
44 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen" />
45 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
46 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
47
48 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen" />
49 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
50
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]51 <script type="text/javascript">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]52 $(document).ready(function() {
53 $(".fancybox").fancybox();
54 });
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]55 </script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]56
57 <!-- ImageMagick style -->
58 <style type="text/css" media="all">
59 @import url("../../www/magick.css");
60 </style>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]61</head>
62
63<body id="www-imagemagick-org">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]64
65<script>
66 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
67 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
68 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
69 })(window,document,'offline-script','//127.0.0.1/analytics.js','ga');
70
71 ga('create', 'UA-40133312-1', 'imagemagick.org');
72 ga('send', 'pageview');
73</script>
74
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]75<div class="titlebar">
76<div style="margin: 17px auto; float: left;">
77 <script type="text/javascript">
78 <!--
79 google_ad_client = "pub-3129977114552745";
80 google_ad_slot = "5439289906";
81 google_ad_width = 728;
82 google_ad_height = 90;
83 //-->
84 </script>
85 <script type="text/javascript"
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]86 src="http://127.0.0.1/pagead/show_ads.js">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]87 </script>
88</div>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]89<a href="http://www.imagemagick.org/discourse-server/">
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]90 <img src="../../images/logo.jpg"
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]91 alt="ImageMagick Logo"
92 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]93<a href="../../index.html">
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]94 <img src="../../images/sprite.jpg"
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]95 alt="ImageMagick Sprite"
96 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
97</div>
98
99<div class="westbar">
100
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101<div class="menu">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]102 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]105 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]106</div>
107<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]108 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]109</div>
110<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]111 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]112</div>
113<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]114 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]115</div>
116<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]117 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]118</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]119<div class="sep"></div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]120<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]121 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122</div>
123<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]124 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125</div>
126<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]127 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128</div>
129<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]131</div>
132<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]133 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]136 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
138<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]139 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140</div>
141<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]142 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
144<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]145 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]149 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]152 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]153</div>
154<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]155 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]156 </div>
157<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]158 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]159</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]160<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]161 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]162</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]163<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]164 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]165</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]166<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]167<div class="menu">
cristy3dfa2192013-02-24 22:46:05 +0000[diff] [blame]168 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]169</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]170<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]171<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]172 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]173</div>
174<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]175 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]176</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]177<div class="sep"></div>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]178<div class="menu">
179 <a title="Support ImageMagick Development" href="../../www/support.html">Support ImageMagick Development</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]180</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]181</div>
182
183<div class="eastbar">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]184 <script type="text/javascript">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]185 /* <![CDATA[ */
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]186 (function() {
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]187 var po = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
188 po.type = 'text/javascript';
189 po.async = true;
190 po.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
191 var script = document.getElementsByTagName('offline-script')[0];
192 script.parentNode.insertBefore(po, script);
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]193 })();
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]194 /* ]]> */
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]195 </script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]196 <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://www.imagemagick.org/"></a></div>
197 <noscript>
198 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
199 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0" /></a>
200 </noscript>
201 <div class="g-plusone" id="gplusone"></div>
202 <script type="text/javascript">
203 /* <![CDATA[ */
204 window.___gcfg = {
205 lang: 'en-US'
206 };
207
208 (function() {
209 var po = document.createElement('offline-script');
210 po.type = 'text/javascript';
211 po.async = true;
212 po.src = 'https://127.0.0.1/js/plusone.js';
213 var script = document.getElementsByTagName('offline-script')[0];
214 script.parentNode.insertBefore(po, script);
215 })();
216 var gplusone = document.getElementById("gplusone");
217 gplusone.setAttribute("data-size","medium");
218 gplusone.setAttribute("data-count","true");
219 /* ]]> */
220 </script>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]221</div>
222
223<div class="main">
224
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]225<h1>Module cache-view Methods</h1>
cristydba8f1d2013-07-28 13:49:24 +0000[diff] [blame^]226<p class="navigation-index">[<a href="cache-view.html#AcquireAuthenticCacheView">AcquireAuthenticCacheView</a> &#8226; <a href="cache-view.html#AcquireVirtualCacheView">AcquireVirtualCacheView</a> &#8226; <a href="cache-view.html#CloneCacheView">CloneCacheView</a> &#8226; <a href="cache-view.html#DestroyCacheView">DestroyCacheView</a> &#8226; <a href="cache-view.html#GetCacheViewChannels">GetCacheViewChannels</a> &#8226; <a href="cache-view.html#GetCacheViewColorspace">GetCacheViewColorspace</a> &#8226; <a href="cache-view.html#GetCacheViewException">GetCacheViewException</a> &#8226; <a href="cache-view.html#GetCacheViewStorageClass">GetCacheViewStorageClass</a> &#8226; <a href="cache-view.html#GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a> &#8226; <a href="cache-view.html#GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a> &#8226; <a href="cache-view.html#GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a> &#8226; <a href="cache-view.html#GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a> &#8226; <a href="cache-view.html#GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a> &#8226; <a href="cache-view.html#GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a> &#8226; <a href="cache-view.html#GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a> &#8226; <a href="cache-view.html#GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a> &#8226; <a href="cache-view.html#GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a> &#8226; <a href="cache-view.html#QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a> &#8226; <a href="cache-view.html#SetCacheViewStorageClass">SetCacheViewStorageClass</a> &#8226; <a href="cache-view.html#SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a> &#8226; <a href="cache-view.html#SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a>]</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]227
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]228<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireAuthenticCacheView">AcquireAuthenticCacheView</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]229<div class="doc-section">
230
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]231<p>AcquireAuthenticCacheView() acquires an authentic view into the pixel cache.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]232
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]233<p>The format of the AcquireAuthenticCacheView method is:</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]234
235<pre class="code">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]236 CacheView *AcquireAuthenticCacheView(const Image *image,
237 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]238</pre>
239
240<p>A description of each parameter follows:</p>
241
242<h5>image</h5>
243<p>the image.</p>
244
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]245<h5>exception</h5>
246<p>return any errors or warnings in this structure.</p>
247
248 </div>
249<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireVirtualCacheView">AcquireVirtualCacheView</a></h2>
250<div class="doc-section">
251
252<p>AcquireVirtualCacheView() acquires a virtual view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p>
253
254<p>The format of the AcquireVirtualCacheView method is:</p>
255
256<pre class="code">
257 CacheView *AcquireVirtualCacheView(const Image *image,
258 ExceptionInfo *exception)
259</pre>
260
261<p>A description of each parameter follows:</p>
262
263<h5>image</h5>
264<p>the image.</p>
265
266<h5>exception</h5>
267<p>return any errors or warnings in this structure.</p>
268
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]269 </div>
270<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="CloneCacheView">CloneCacheView</a></h2>
271<div class="doc-section">
272
273<p>CloneCacheView() makes an exact copy of the specified cache view.</p>
274
275<p>The format of the CloneCacheView method is:</p>
276
277<pre class="code">
278 CacheView *CloneCacheView(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_8c.html" id="DestroyCacheView">DestroyCacheView</a></h2>
288<div class="doc-section">
289
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]290<p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireVirtualCacheView().</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]291
292<p>The format of the DestroyCacheView method is:</p>
293
294<pre class="code">
295 CacheView *DestroyCacheView(CacheView *cache_view)
296</pre>
297
298<p>A description of each parameter follows:</p>
299
300<h5>cache_view</h5>
301<p>the cache view.</p>
302
303 </div>
304<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewChannels">GetCacheViewChannels</a></h2>
305<div class="doc-section">
306
307<p>GetCacheViewChannels() returns the image pixel channels associated with the specified view.</p>
308
309<p>The format of the GetCacheViewChannels method is:</p>
310
311<pre class="code">
312 size_t GetCacheViewChannels(const CacheView *cache_view)
313</pre>
314
315<p>A description of each parameter follows:</p>
316
317<h5>cache_view</h5>
318<p>the cache view.</p>
319
320 </div>
321<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
322<div class="doc-section">
323
324<p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p>
325
326<p>The format of the GetCacheViewColorspace method is:</p>
327
328<pre class="code">
329 ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
330</pre>
331
332<p>A description of each parameter follows:</p>
333
334<h5>cache_view</h5>
335<p>the cache view.</p>
336
337 </div>
338<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewException">GetCacheViewException</a></h2>
339<div class="doc-section">
340
341<p>GetCacheViewException() returns the image exception associated with the specified view.</p>
342
343<p>The format of the GetCacheViewException method is:</p>
344
345<pre class="code">
346 ExceptionInfo GetCacheViewException(const CacheView *cache_view)
347</pre>
348
349<p>A description of each parameter follows:</p>
350
351<h5>cache_view</h5>
352<p>the cache view.</p>
353
354 </div>
355<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
356<div class="doc-section">
357
358<p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p>
359
360<p>The format of the GetCacheViewStorageClass method is:</p>
361
362<pre class="code">
363 ClassType GetCacheViewStorageClass(const CacheView *cache_view)
364</pre>
365
366<p>A description of each parameter follows:</p>
367
368<h5>cache_view</h5>
369<p>the cache view.</p>
370
371 </div>
372<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
373<div class="doc-section">
374
375<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>
376
377<p>The format of the GetCacheViewAuthenticPixels method is:</p>
378
379<pre class="code">
380 PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
381 const ssize_t x,const ssize_t y,const size_t columns,
382 const size_t rows,ExceptionInfo *exception)
383</pre>
384
385<p>A description of each parameter follows:</p>
386
387<h5>cache_view</h5>
388<p>the cache view.</p>
389
390<h5>x,y,columns,rows</h5>
391<p>These values define the perimeter of a region of pixels.</p>
392
393 </div>
394<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
395<div class="doc-section">
396
397<p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p>
398
399<p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
400
401<pre class="code">
402 MagickBooleaNType GetOneCacheViewAuthenticPixel(
403 const CacheView *cache_view,const ssize_t x,const ssize_t y,
404 Pixelpacket *pixel,ExceptionInfo *exception)
405</pre>
406
407<p>A description of each parameter follows:</p>
408
409<h5>cache_view</h5>
410<p>the cache view.</p>
411
412<h5>x,y</h5>
413<p>These values define the offset of the pixel.</p>
414
415<h5>pixel</h5>
416<p>return a pixel at the specified (x,y) location.</p>
417
418<h5>exception</h5>
419<p>return any errors or warnings in this structure.</p>
420
421 </div>
422<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
423<div class="doc-section">
424
425<p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.</p>
426
427<p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
428
429<pre class="code">
430 IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
431</pre>
432
433<p>A description of each parameter follows:</p>
434
435<h5>cache_view</h5>
436<p>the cache view.</p>
437
438 </div>
439<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
440<div class="doc-section">
441
442<p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be updated.</p>
443
444<p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
445
446<pre class="code">
447 PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
448</pre>
449
450<p>A description of each parameter follows:</p>
451
452<h5>cache_view</h5>
453<p>the cache view.</p>
454
455 </div>
456<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
457<div class="doc-section">
458
459<p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.</p>
460
461<p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
462
463<pre class="code">
464 const IndexPacket *GetCacheViewVirtualIndexQueue(
465 const CacheView *cache_view)
466</pre>
467
468<p>A description of each parameter follows:</p>
469
470<h5>cache_view</h5>
471<p>the cache view.</p>
472
473 </div>
474<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
475<div class="doc-section">
476
477<p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p>
478
479<p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
480
481<pre class="code">
482 const PixelPacket *GetCacheViewVirtualPixelQueue(
483 const CacheView *cache_view)
484</pre>
485
486<p>A description of each parameter follows:</p>
487
488<h5>cache_view</h5>
489<p>the cache view.</p>
490
491 </div>
492<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
493<div class="doc-section">
494
495<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>
496
497<p>The format of the GetCacheViewVirtualPixels method is:</p>
498
499<pre class="code">
500 const PixelPacket *GetCacheViewVirtualPixels(
501 const CacheView *cache_view,const ssize_t x,const ssize_t y,
502 const size_t columns,const size_t rows,ExceptionInfo *exception)
503</pre>
504
505<p>A description of each parameter follows:</p>
506
507<h5>cache_view</h5>
508<p>the cache view.</p>
509
510<h5>x,y,columns,rows</h5>
511<p>These values define the perimeter of a region of pixels.</p>
512
513<h5>exception</h5>
514<p>return any errors or warnings in this structure.</p>
515
516 </div>
517<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
518<div class="doc-section">
519
520<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>
521
522<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
523
524<pre class="code">
525 MagickBooleanType GetOneCacheViewVirtualPixel(
526 const CacheView *cache_view,const ssize_t x,const ssize_t y,
527 PixelPacket *pixel,ExceptionInfo *exception)
528</pre>
529
530<p>A description of each parameter follows:</p>
531
532<h5>cache_view</h5>
533<p>the cache view.</p>
534
535<h5>x,y</h5>
536<p>These values define the offset of the pixel.</p>
537
538<h5>pixel</h5>
539<p>return a pixel at the specified (x,y) location.</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_8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
546<div class="doc-section">
547
548<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>
549
550<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
551
552<pre class="code">
553 MagickBooleanType GetOneCacheViewVirtualMethodPixel(
554 const CacheView *cache_view,
555 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
556 const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
557</pre>
558
559<p>A description of each parameter follows:</p>
560
561<h5>cache_view</h5>
562<p>the cache view.</p>
563
564<h5>virtual_pixel_method</h5>
565<p>the virtual pixel method.</p>
566
567<h5>x,y</h5>
568<p>These values define the offset of the pixel.</p>
569
570<h5>pixel</h5>
571<p>return a pixel at the specified (x,y) location.</p>
572
573<h5>exception</h5>
574<p>return any errors or warnings in this structure.</p>
575
576 </div>
577<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
578<div class="doc-section">
579
580<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>
581
582<p>The format of the QueueCacheViewAuthenticPixels method is:</p>
583
584<pre class="code">
585 PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
586 const ssize_t x,const ssize_t y,const size_t columns,
587 const size_t rows,ExceptionInfo *exception)
588</pre>
589
590<p>A description of each parameter follows:</p>
591
592<h5>cache_view</h5>
593<p>the cache view.</p>
594
595<h5>x,y,columns,rows</h5>
596<p>These values define the perimeter of a region of pixels.</p>
597
598<h5>exception</h5>
599<p>return any errors or warnings in this structure.</p>
600
601 </div>
602<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
603<div class="doc-section">
604
605<p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p>
606
607<p>The format of the SetCacheViewStorageClass method is:</p>
608
609<pre class="code">
610 MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
611 const ClassType storage_class)
612</pre>
613
614<p>A description of each parameter follows:</p>
615
616<h5>cache_view</h5>
617<p>the cache view.</p>
618
619<h5>storage_class</h5>
620<p>the image storage class: PseudoClass or DirectClass.</p>
621
622 </div>
623<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
624<div class="doc-section">
625
626<p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p>
627
628<p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
629
630<pre class="code">
631 MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
632 const VirtualPixelMethod virtual_pixel_method)
633</pre>
634
635<p>A description of each parameter follows:</p>
636
637<h5>cache_view</h5>
638<p>the cache view.</p>
639
640<h5>virtual_pixel_method</h5>
641<p>the virtual pixel method.</p>
642
643 </div>
644<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
645<div class="doc-section">
646
647<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>
648
649<p>The format of the SyncCacheViewAuthenticPixels method is:</p>
650
651<pre class="code">
652 MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
653 ExceptionInfo *exception)
654</pre>
655
656<p>A description of each parameter follows:</p>
657
658<h5>cache_view</h5>
659<p>the cache view.</p>
660
661<h5>exception</h5>
662<p>return any errors or warnings in this structure.</p>
663
664 </div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]665
666</div>
667
668<div id="linkbar">
669 <span id="linkbar-west">&nbsp;</span>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]670
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]671 <span id="linkbar-center">
cristydba8f1d2013-07-28 13:49:24 +0000[diff] [blame^]672 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &#8226;
673 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> &#8226;
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]674 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]675 </span>
676 <span id="linkbar-east">&nbsp;</span>
677 </div>
678 <div class="footer">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]679 <span id="footer-west">&copy; 1999-2013 ImageMagick Studio LLC</span>
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]680 <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]681 </div>
682 <div style="clear: both; margin: 0; width: 100%; "></div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]683</body>
684</html>