Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / d8833bfff34db3ff19b83bdbd945099719f15431 / . / www / api / cache-view.html
blob: 963819cb86ef4c1e1d22a75727a2c304b3b2546e [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"/>
10 <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
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"/>
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 automagically."/>
17 <meta name="application-url" content="http://www.imagemagick.org"/>
18 <meta name="generator" content="PHP"/>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]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, Image, Processing, Automagically"/>
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"/>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]32 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]33 <link rel="stylesheet" type="text/css" href="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.css" media="screen" />
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]34 <style type="text/css" media="all">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]35 @import url("../../style/magick.html");
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]36 </style>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]37 <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
38 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
39 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.pack.js"></script>
40 <script type="text/javascript">
41 $(document).ready(function() {
42 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
43 'transitionIn' : 'elastic',
44 'transitionOut' : 'elastic',
45 'overlayShow' : false,
46 'opacity' : true
47 });
48 });
49 </script>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]50</head>
51
52<body id="www-imagemagick-org">
53<div class="titlebar">
54<div style="margin: 17px auto; float: left;">
55 <script type="text/javascript">
56 <!--
57 google_ad_client = "pub-3129977114552745";
58 google_ad_slot = "5439289906";
59 google_ad_width = 728;
60 google_ad_height = 90;
61 //-->
62 </script>
63 <script type="text/javascript"
64 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
65 </script>
66</div>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]67<a href="../../discourse-server">
68 <img src="../../images/logo.jpg"
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]69 alt="ImageMagick Logo"
70 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]71<a href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]72 <img src="../../images/sprite.jpg"
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]73 alt="ImageMagick Sprite"
74 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
75</div>
76
77<div class="westbar">
78
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]80 <a title="About ImageMagick" href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]83 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]84</div>
85<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]86 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]87</div>
88<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]89 <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]90</div>
91<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]92 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]93</div>
94<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]95 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]96</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]97<div class="sep"></div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]98<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]99 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]102 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
104<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]105 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
107<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
110<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]111 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
113<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]114 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115</div>
116<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]117 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118</div>
119<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]120 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121</div>
122<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]123 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]125<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]127 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128</div>
129<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]130 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]131</div>
132<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]133 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134 </div>
135<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]136 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]138<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]139 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]140</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]142 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]146 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]148<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]149<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]150 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]151</div>
152<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]153 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]154</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]155<div class="sep"></div>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]156<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]157 <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]158
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]159<a href="http://www.networkredux.com">
160 <img src="../../images/networkredux.png" width="140" height="31" alt="[sponsor]"
161 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]162<div class="sponsbox">
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]163<div class="sponsor">
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]164 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
165</div>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]166<div class="sponsor">
167 <a rel="follow" title="Sponsor: Stock Photography" href="http://www.fotosearch.com/">Stock Photography</a><!-- 2012040100250 ... -->
168</div>
169<div class="sponsor">
170 <a rel="follow" title="Sponsor: Best Local Services" href="http://www.openchime.com">Best Local Services</a><!-- 2012010100150 joey@openc... -->
171</div>
172<div class="sponsor">
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]173 <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
174</div>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]175<div class="sponsor">
176 <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201201010090 barsh@inter... -->
177</div>
178<div class="sponsor">
179 <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540 suvalj -->
180</div>
181<div class="sponsor">
182 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
183</div>
184<div class="sponsor">
185 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
186</div>
187<div class="sponsor">
188 <a rel="follow" title="Sponsor: Autos part" href="http://www.pkwteile.de/autoteile">Autos part</a><!-- 201112010090s jr@pkwte... -->
189</div>
190<div class="sponsor">
191 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
192</div>
193<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]194 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000[diff] [blame]195</div>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]196<div class="sponsor">
197 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]198</div>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]199<div class="sponsor">
200 <a rel="follow" title="Sponsor: Photo Sharing Websites" href="http://www.zoofoo.com">Photo Sharing Websites</a><!-- 2012050100150 dancu@dans...-->
201</div>
202<div class="sponsor">
203 <a rel="follow" title="Sponsor: Got Stripes?" href="http://www.stripeslawncare.org">Got Stripes?</a><!-- 2012010100150 brooks@stripes...-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]204</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]205</div>
206</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]207</div>
208
209<div class="eastbar">
210 <div class="g-plusone" id="gplusone"></div>
211 <script type="text/javascript">
212 window.___gcfg = {
213 lang: 'en-US'
214 };
215
216 (function() {
cristy18b955e2013-02-24 21:06:33 +0000[diff] [blame]217 var po = document.createElement('offline-script');
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]218 po.type = 'text/javascript'; po.async = true;
219 po.src = 'https://apis.google.com/js/plusone.js';
cristy18b955e2013-02-24 21:06:33 +0000[diff] [blame]220 var script = document.getElementsByTagName('offline-script')[0];
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]221 script.parentNode.insertBefore(po, script);
222 })();
223 var gplusone = document.getElementById("gplusone");
224 gplusone.setAttribute("data-size","medium");
225 gplusone.setAttribute("data-count","false");
226 </script>
227</div>
228
229<div class="main">
230
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]231<h1>Module cache-view Methods</h1>
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]232<p class="navigation-index">[<a href="cache-view.html#AcquireAuthenticCacheView">AcquireAuthenticCacheView</a> &bull; <a href="cache-view.html#AcquireVirtualCacheView">AcquireVirtualCacheView</a> &bull; <a href="cache-view.html#CloneCacheView">CloneCacheView</a> &bull; <a href="cache-view.html#DestroyCacheView">DestroyCacheView</a> &bull; <a href="cache-view.html#GetCacheViewChannels">GetCacheViewChannels</a> &bull; <a href="cache-view.html#GetCacheViewColorspace">GetCacheViewColorspace</a> &bull; <a href="cache-view.html#GetCacheViewException">GetCacheViewException</a> &bull; <a href="cache-view.html#GetCacheViewStorageClass">GetCacheViewStorageClass</a> &bull; <a href="cache-view.html#GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a> &bull; <a href="cache-view.html#GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a> &bull; <a href="cache-view.html#GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a> &bull; <a href="cache-view.html#GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a> &bull; <a href="cache-view.html#GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a> &bull; <a href="cache-view.html#GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a> &bull; <a href="cache-view.html#GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a> &bull; <a href="cache-view.html#GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a> &bull; <a href="cache-view.html#GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a> &bull; <a href="cache-view.html#QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a> &bull; <a href="cache-view.html#SetCacheViewStorageClass">SetCacheViewStorageClass</a> &bull; <a href="cache-view.html#SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a> &bull; <a href="cache-view.html#SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a>]</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]233
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]234<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]235<div class="doc-section">
236
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]237<p>AcquireAuthenticCacheView() acquires an authentic view into the pixel cache.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]238
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]239<p>The format of the AcquireAuthenticCacheView method is:</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]240
241<pre class="code">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]242 CacheView *AcquireAuthenticCacheView(const Image *image,
243 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]244</pre>
245
246<p>A description of each parameter follows:</p>
247
248<h5>image</h5>
249<p>the image.</p>
250
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]251<h5>exception</h5>
252<p>return any errors or warnings in this structure.</p>
253
254 </div>
255<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireVirtualCacheView">AcquireVirtualCacheView</a></h2>
256<div class="doc-section">
257
258<p>AcquireVirtualCacheView() acquires a virtual view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p>
259
260<p>The format of the AcquireVirtualCacheView method is:</p>
261
262<pre class="code">
263 CacheView *AcquireVirtualCacheView(const Image *image,
264 ExceptionInfo *exception)
265</pre>
266
267<p>A description of each parameter follows:</p>
268
269<h5>image</h5>
270<p>the image.</p>
271
272<h5>exception</h5>
273<p>return any errors or warnings in this structure.</p>
274
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]275 </div>
276<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="CloneCacheView">CloneCacheView</a></h2>
277<div class="doc-section">
278
279<p>CloneCacheView() makes an exact copy of the specified cache view.</p>
280
281<p>The format of the CloneCacheView method is:</p>
282
283<pre class="code">
284 CacheView *CloneCacheView(const CacheView *cache_view)
285</pre>
286
287<p>A description of each parameter follows:</p>
288
289<h5>cache_view</h5>
290<p>the cache view.</p>
291
292 </div>
293<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="DestroyCacheView">DestroyCacheView</a></h2>
294<div class="doc-section">
295
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]296<p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireVirtualCacheView().</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]297
298<p>The format of the DestroyCacheView method is:</p>
299
300<pre class="code">
301 CacheView *DestroyCacheView(CacheView *cache_view)
302</pre>
303
304<p>A description of each parameter follows:</p>
305
306<h5>cache_view</h5>
307<p>the cache view.</p>
308
309 </div>
310<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewChannels">GetCacheViewChannels</a></h2>
311<div class="doc-section">
312
313<p>GetCacheViewChannels() returns the image pixel channels associated with the specified view.</p>
314
315<p>The format of the GetCacheViewChannels method is:</p>
316
317<pre class="code">
318 size_t GetCacheViewChannels(const CacheView *cache_view)
319</pre>
320
321<p>A description of each parameter follows:</p>
322
323<h5>cache_view</h5>
324<p>the cache view.</p>
325
326 </div>
327<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
328<div class="doc-section">
329
330<p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p>
331
332<p>The format of the GetCacheViewColorspace method is:</p>
333
334<pre class="code">
335 ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
336</pre>
337
338<p>A description of each parameter follows:</p>
339
340<h5>cache_view</h5>
341<p>the cache view.</p>
342
343 </div>
344<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewException">GetCacheViewException</a></h2>
345<div class="doc-section">
346
347<p>GetCacheViewException() returns the image exception associated with the specified view.</p>
348
349<p>The format of the GetCacheViewException method is:</p>
350
351<pre class="code">
352 ExceptionInfo GetCacheViewException(const CacheView *cache_view)
353</pre>
354
355<p>A description of each parameter follows:</p>
356
357<h5>cache_view</h5>
358<p>the cache view.</p>
359
360 </div>
361<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
362<div class="doc-section">
363
364<p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p>
365
366<p>The format of the GetCacheViewStorageClass method is:</p>
367
368<pre class="code">
369 ClassType GetCacheViewStorageClass(const CacheView *cache_view)
370</pre>
371
372<p>A description of each parameter follows:</p>
373
374<h5>cache_view</h5>
375<p>the cache view.</p>
376
377 </div>
378<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
379<div class="doc-section">
380
381<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>
382
383<p>The format of the GetCacheViewAuthenticPixels method is:</p>
384
385<pre class="code">
386 PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
387 const ssize_t x,const ssize_t y,const size_t columns,
388 const size_t rows,ExceptionInfo *exception)
389</pre>
390
391<p>A description of each parameter follows:</p>
392
393<h5>cache_view</h5>
394<p>the cache view.</p>
395
396<h5>x,y,columns,rows</h5>
397<p>These values define the perimeter of a region of pixels.</p>
398
399 </div>
400<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
401<div class="doc-section">
402
403<p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p>
404
405<p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
406
407<pre class="code">
408 MagickBooleaNType GetOneCacheViewAuthenticPixel(
409 const CacheView *cache_view,const ssize_t x,const ssize_t y,
410 Pixelpacket *pixel,ExceptionInfo *exception)
411</pre>
412
413<p>A description of each parameter follows:</p>
414
415<h5>cache_view</h5>
416<p>the cache view.</p>
417
418<h5>x,y</h5>
419<p>These values define the offset of the pixel.</p>
420
421<h5>pixel</h5>
422<p>return a pixel at the specified (x,y) location.</p>
423
424<h5>exception</h5>
425<p>return any errors or warnings in this structure.</p>
426
427 </div>
428<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
429<div class="doc-section">
430
431<p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.</p>
432
433<p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
434
435<pre class="code">
436 IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
437</pre>
438
439<p>A description of each parameter follows:</p>
440
441<h5>cache_view</h5>
442<p>the cache view.</p>
443
444 </div>
445<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
446<div class="doc-section">
447
448<p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be updated.</p>
449
450<p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
451
452<pre class="code">
453 PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
454</pre>
455
456<p>A description of each parameter follows:</p>
457
458<h5>cache_view</h5>
459<p>the cache view.</p>
460
461 </div>
462<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
463<div class="doc-section">
464
465<p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.</p>
466
467<p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
468
469<pre class="code">
470 const IndexPacket *GetCacheViewVirtualIndexQueue(
471 const CacheView *cache_view)
472</pre>
473
474<p>A description of each parameter follows:</p>
475
476<h5>cache_view</h5>
477<p>the cache view.</p>
478
479 </div>
480<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
481<div class="doc-section">
482
483<p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p>
484
485<p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
486
487<pre class="code">
488 const PixelPacket *GetCacheViewVirtualPixelQueue(
489 const CacheView *cache_view)
490</pre>
491
492<p>A description of each parameter follows:</p>
493
494<h5>cache_view</h5>
495<p>the cache view.</p>
496
497 </div>
498<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
499<div class="doc-section">
500
501<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>
502
503<p>The format of the GetCacheViewVirtualPixels method is:</p>
504
505<pre class="code">
506 const PixelPacket *GetCacheViewVirtualPixels(
507 const CacheView *cache_view,const ssize_t x,const ssize_t y,
508 const size_t columns,const size_t rows,ExceptionInfo *exception)
509</pre>
510
511<p>A description of each parameter follows:</p>
512
513<h5>cache_view</h5>
514<p>the cache view.</p>
515
516<h5>x,y,columns,rows</h5>
517<p>These values define the perimeter of a region of pixels.</p>
518
519<h5>exception</h5>
520<p>return any errors or warnings in this structure.</p>
521
522 </div>
523<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
524<div class="doc-section">
525
526<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>
527
528<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
529
530<pre class="code">
531 MagickBooleanType GetOneCacheViewVirtualPixel(
532 const CacheView *cache_view,const ssize_t x,const ssize_t y,
533 PixelPacket *pixel,ExceptionInfo *exception)
534</pre>
535
536<p>A description of each parameter follows:</p>
537
538<h5>cache_view</h5>
539<p>the cache view.</p>
540
541<h5>x,y</h5>
542<p>These values define the offset of the pixel.</p>
543
544<h5>pixel</h5>
545<p>return a pixel at the specified (x,y) location.</p>
546
547<h5>exception</h5>
548<p>return any errors or warnings in this structure.</p>
549
550 </div>
551<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
552<div class="doc-section">
553
554<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>
555
556<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
557
558<pre class="code">
559 MagickBooleanType GetOneCacheViewVirtualMethodPixel(
560 const CacheView *cache_view,
561 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
562 const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
563</pre>
564
565<p>A description of each parameter follows:</p>
566
567<h5>cache_view</h5>
568<p>the cache view.</p>
569
570<h5>virtual_pixel_method</h5>
571<p>the virtual pixel method.</p>
572
573<h5>x,y</h5>
574<p>These values define the offset of the pixel.</p>
575
576<h5>pixel</h5>
577<p>return a pixel at the specified (x,y) location.</p>
578
579<h5>exception</h5>
580<p>return any errors or warnings in this structure.</p>
581
582 </div>
583<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
584<div class="doc-section">
585
586<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>
587
588<p>The format of the QueueCacheViewAuthenticPixels method is:</p>
589
590<pre class="code">
591 PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
592 const ssize_t x,const ssize_t y,const size_t columns,
593 const size_t rows,ExceptionInfo *exception)
594</pre>
595
596<p>A description of each parameter follows:</p>
597
598<h5>cache_view</h5>
599<p>the cache view.</p>
600
601<h5>x,y,columns,rows</h5>
602<p>These values define the perimeter of a region of pixels.</p>
603
604<h5>exception</h5>
605<p>return any errors or warnings in this structure.</p>
606
607 </div>
608<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
609<div class="doc-section">
610
611<p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p>
612
613<p>The format of the SetCacheViewStorageClass method is:</p>
614
615<pre class="code">
616 MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
617 const ClassType storage_class)
618</pre>
619
620<p>A description of each parameter follows:</p>
621
622<h5>cache_view</h5>
623<p>the cache view.</p>
624
625<h5>storage_class</h5>
626<p>the image storage class: PseudoClass or DirectClass.</p>
627
628 </div>
629<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
630<div class="doc-section">
631
632<p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p>
633
634<p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
635
636<pre class="code">
637 MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
638 const VirtualPixelMethod virtual_pixel_method)
639</pre>
640
641<p>A description of each parameter follows:</p>
642
643<h5>cache_view</h5>
644<p>the cache view.</p>
645
646<h5>virtual_pixel_method</h5>
647<p>the virtual pixel method.</p>
648
649 </div>
650<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
651<div class="doc-section">
652
653<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>
654
655<p>The format of the SyncCacheViewAuthenticPixels method is:</p>
656
657<pre class="code">
658 MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
659 ExceptionInfo *exception)
660</pre>
661
662<p>A description of each parameter follows:</p>
663
664<h5>cache_view</h5>
665<p>the cache view.</p>
666
667<h5>exception</h5>
668<p>return any errors or warnings in this structure.</p>
669
670 </div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]671
672</div>
673
674<div id="linkbar">
675 <span id="linkbar-west">&nbsp;</span>
676 <span id="linkbar-center">
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]677 <a href="../../discourse-server">Discourse Server</a> &bull;
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]678 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
679 </span>
680 <span id="linkbar-east">&nbsp;</span>
681 </div>
682 <div class="footer">
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]683 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame^]684 <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]685 </div>
686 <div style="clear: both; margin: 0; width: 100%; "></div>
687 <script type="text/javascript">
688 var _gaq = _gaq || [];
689 _gaq.push(['_setAccount', 'UA-17690367-1']);
690 _gaq.push(['_trackPageview']);
691
692 (function() {
cristy18b955e2013-02-24 21:06:33 +0000[diff] [blame]693 var ga = document.createElement('offline-script'); ga.type = 'text/javascript'; ga.async = true;
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]694 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
cristy18b955e2013-02-24 21:06:33 +0000[diff] [blame]695 var s = document.getElementsByTagName('offline-script')[0]; s.parentNode.insertBefore(ga, s);
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]696 })();
697 </script>
698</body>
699</html>