Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 20398435da786d6943c9b5c121181895371c422c / . / www / api / cache-view.html
blob: 76e6239c322f646a3da805eaf54437c065e91847 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]3<html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]8<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]12 <meta http-equiv="Content-Language" content="en-US"/>
13 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
14 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]15 <meta name="Application-name" content="ImageMagick"/>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]16 <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images automagically."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]17 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]18 <meta name="Generator" content="PHP"/>
cristye6e84152011-06-06 14:16:49 +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"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]20 <meta name="Rating" content="GENERAL"/>
21 <meta name="Robots" content="INDEX, FOLLOW"/>
22 <meta name="Generator" content="ImageMagick Studio LLC"/>
23 <meta name="Author" content="ImageMagick Studio LLC"/>
24 <meta name="Revisit-after" content="2 DAYS"/>
25 <meta name="Resource-type" content="document"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]26 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]27 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]28 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]30 <link rel="canonical" href="http://www.imagemagick.org" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]31 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]32 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]33 <link rel="stylesheet" type="text/css" href="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.css" media="screen" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]34 <style type="text/css" media="all">
35 @import url("../../www/magick.css");
36 </style>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]37 <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]38 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"></script>
39 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.pack.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]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>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50</head>
51
52<body id="www-imagemagick-org">
53<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]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>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]67<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]68 <img src="../../images/logo.jpg"
69 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]70 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]71<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]72 <img src="../../images/sprite.jpg"
73 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]74 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
75</div>
76
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]77<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]78
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="About ImageMagick" href="../../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">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]83 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
84</div>
85<div class="sub">
86 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
90</div>
91<div class="sub">
cristye6e84152011-06-06 14:16:49 +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">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]95 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
96</div>
97<div class="sep"></div>
98<div class="menu">
cristy83a272e2010-05-07 20:40:35 +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">
cristy83a272e2010-05-07 20:40:35 +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">
cristy83a272e2010-05-07 20:40:35 +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">
cristy83a272e2010-05-07 20:40:35 +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">
cristy83a272e2010-05-07 20:40:35 +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">
cristy83a272e2010-05-07 20:40:35 +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">
cristy83a272e2010-05-07 20:40:35 +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">
cristydcca3fa2010-12-29 21:50:07 +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>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]125<div class="sep"></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="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">
cristy83a272e2010-05-07 20:40:35 +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">
cristy83a272e2010-05-07 20:40:35 +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">
cristy83a272e2010-05-07 20:40:35 +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">
139 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
140</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="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]146 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]148<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]149<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +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">
cristyffb69ed2010-12-25 00:06:48 +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>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]155<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]156<div class="menu">
cristy10549a12011-05-15 19:04:46 +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
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]159<a href="http://www.networkredux.com">
cristyaf894d72011-08-06 23:03:10 +0000[diff] [blame]160 <img src="../../images/networkredux.png" width="140" height="31" alt="[sponsor]"
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]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">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]163<div class="sponsor">
cristyaf894d72011-08-06 23:03:10 +0000[diff] [blame]164 <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540s suvalj -->
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]165</div>
166<div class="sponsor">
cristyaf894d72011-08-06 23:03:10 +0000[diff] [blame]167 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]168</div>
169<div class="sponsor">
cristy84134182011-06-15 22:59:00 +0000[diff] [blame]170 <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
171</div>
172<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]173 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
174</div>
175<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]176 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
177</div>
178<div class="sponsor">
cristyaf894d72011-08-06 23:03:10 +0000[diff] [blame]179 <a rel="follow" title="Sponsor: Autos part" href="http://www.pkwteile.de/autoteile">Autos part</a><!-- 201112010090s jr@pkwte... -->
180</div>
181<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]182 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
183</div>
184<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]185 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]186</div>
187<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]188 <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]189</div>
190<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000[diff] [blame]191 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]192</div>
193<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]194 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]195</div>
196<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]197 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]198</div>
199<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]200 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]201</div>
202<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]203 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]204</div>
205<div class="sponsor">
cristy20398432011-08-11 01:31:50 +0000[diff] [blame^]206 <a rel="follow" title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]207</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]208</div>
209</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]210</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]211
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]212<div class="eastbar">
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]213 <div class="g-plusone" data-size="standard" data-count="false"></div>
214</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]215
216<div class="main">
217
cristy20398432011-08-11 01:31:50 +0000[diff] [blame^]218<h1>Module cache-view Methods</h1>
219<p class="navigation-index">[<a href="#AcquireCacheView">AcquireCacheView</a> &bull; <a href="#CloneCacheView">CloneCacheView</a> &bull; <a href="#DestroyCacheView">DestroyCacheView</a> &bull; <a href="#GetCacheViewChannels">GetCacheViewChannels</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>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]220
cristy20398432011-08-11 01:31:50 +0000[diff] [blame^]221<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireCacheView">AcquireCacheView</a></h2>
222<div class="doc-section">
223
224<p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p>
225
226<p>The format of the AcquireCacheView method is:</p>
227
228<pre class="code">
229 CacheView *AcquireCacheView(const Image *image)
230</pre>
231
232<p>A description of each parameter follows:</p>
233
234<h5>image</h5>
235<p>the image.</p>
236
237 </div>
238<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="CloneCacheView">CloneCacheView</a></h2>
239<div class="doc-section">
240
241<p>CloneCacheView() makes an exact copy of the specified cache view.</p>
242
243<p>The format of the CloneCacheView method is:</p>
244
245<pre class="code">
246 CacheView *CloneCacheView(const CacheView *cache_view)
247</pre>
248
249<p>A description of each parameter follows:</p>
250
251<h5>cache_view</h5>
252<p>the cache view.</p>
253
254 </div>
255<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="DestroyCacheView">DestroyCacheView</a></h2>
256<div class="doc-section">
257
258<p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p>
259
260<p>The format of the DestroyCacheView method is:</p>
261
262<pre class="code">
263 CacheView *DestroyCacheView(CacheView *cache_view)
264</pre>
265
266<p>A description of each parameter follows:</p>
267
268<h5>cache_view</h5>
269<p>the cache view.</p>
270
271 </div>
272<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewChannels">GetCacheViewChannels</a></h2>
273<div class="doc-section">
274
275<p>GetCacheViewChannels() returns the image pixel channels associated with the specified view.</p>
276
277<p>The format of the GetCacheViewChannels method is:</p>
278
279<pre class="code">
280 size_t GetCacheViewChannels(const CacheView *cache_view)
281</pre>
282
283<p>A description of each parameter follows:</p>
284
285<h5>cache_view</h5>
286<p>the cache view.</p>
287
288 </div>
289<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
290<div class="doc-section">
291
292<p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p>
293
294<p>The format of the GetCacheViewColorspace method is:</p>
295
296<pre class="code">
297 ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
298</pre>
299
300<p>A description of each parameter follows:</p>
301
302<h5>cache_view</h5>
303<p>the cache view.</p>
304
305 </div>
306<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewException">GetCacheViewException</a></h2>
307<div class="doc-section">
308
309<p>GetCacheViewException() returns the image exception associated with the specified view.</p>
310
311<p>The format of the GetCacheViewException method is:</p>
312
313<pre class="code">
314 ExceptionInfo GetCacheViewException(const CacheView *cache_view)
315</pre>
316
317<p>A description of each parameter follows:</p>
318
319<h5>cache_view</h5>
320<p>the cache view.</p>
321
322 </div>
323<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
324<div class="doc-section">
325
326<p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p>
327
328<p>The format of the GetCacheViewStorageClass method is:</p>
329
330<pre class="code">
331 ClassType GetCacheViewStorageClass(const CacheView *cache_view)
332</pre>
333
334<p>A description of each parameter follows:</p>
335
336<h5>cache_view</h5>
337<p>the cache view.</p>
338
339 </div>
340<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
341<div class="doc-section">
342
343<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>
344
345<p>The format of the GetCacheViewAuthenticPixels method is:</p>
346
347<pre class="code">
348 PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
349 const ssize_t x,const ssize_t y,const size_t columns,
350 const size_t rows,ExceptionInfo *exception)
351</pre>
352
353<p>A description of each parameter follows:</p>
354
355<h5>cache_view</h5>
356<p>the cache view.</p>
357
358<h5>x,y,columns,rows</h5>
359<p>These values define the perimeter of a region of pixels.</p>
360
361 </div>
362<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
363<div class="doc-section">
364
365<p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p>
366
367<p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
368
369<pre class="code">
370 MagickBooleaNType GetOneCacheViewAuthenticPixel(
371 const CacheView *cache_view,const ssize_t x,const ssize_t y,
372 Pixelpacket *pixel,ExceptionInfo *exception)
373</pre>
374
375<p>A description of each parameter follows:</p>
376
377<h5>cache_view</h5>
378<p>the cache view.</p>
379
380<h5>x,y</h5>
381<p>These values define the offset of the pixel.</p>
382
383<h5>pixel</h5>
384<p>return a pixel at the specified (x,y) location.</p>
385
386<h5>exception</h5>
387<p>return any errors or warnings in this structure.</p>
388
389 </div>
390<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
391<div class="doc-section">
392
393<p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.</p>
394
395<p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
396
397<pre class="code">
398 IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
399</pre>
400
401<p>A description of each parameter follows:</p>
402
403<h5>cache_view</h5>
404<p>the cache view.</p>
405
406 </div>
407<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
408<div class="doc-section">
409
410<p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be updated.</p>
411
412<p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
413
414<pre class="code">
415 PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
416</pre>
417
418<p>A description of each parameter follows:</p>
419
420<h5>cache_view</h5>
421<p>the cache view.</p>
422
423 </div>
424<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
425<div class="doc-section">
426
427<p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.</p>
428
429<p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
430
431<pre class="code">
432 const IndexPacket *GetCacheViewVirtualIndexQueue(
433 const CacheView *cache_view)
434</pre>
435
436<p>A description of each parameter follows:</p>
437
438<h5>cache_view</h5>
439<p>the cache view.</p>
440
441 </div>
442<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
443<div class="doc-section">
444
445<p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p>
446
447<p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
448
449<pre class="code">
450 const PixelPacket *GetCacheViewVirtualPixelQueue(
451 const CacheView *cache_view)
452</pre>
453
454<p>A description of each parameter follows:</p>
455
456<h5>cache_view</h5>
457<p>the cache view.</p>
458
459 </div>
460<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
461<div class="doc-section">
462
463<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>
464
465<p>The format of the GetCacheViewVirtualPixels method is:</p>
466
467<pre class="code">
468 const PixelPacket *GetCacheViewVirtualPixels(
469 const CacheView *cache_view,const ssize_t x,const ssize_t y,
470 const size_t columns,const size_t rows,ExceptionInfo *exception)
471</pre>
472
473<p>A description of each parameter follows:</p>
474
475<h5>cache_view</h5>
476<p>the cache view.</p>
477
478<h5>x,y,columns,rows</h5>
479<p>These values define the perimeter of a region of pixels.</p>
480
481<h5>exception</h5>
482<p>return any errors or warnings in this structure.</p>
483
484 </div>
485<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
486<div class="doc-section">
487
488<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>
489
490<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
491
492<pre class="code">
493 MagickBooleanType GetOneCacheViewVirtualPixel(
494 const CacheView *cache_view,const ssize_t x,const ssize_t y,
495 PixelPacket *pixel,ExceptionInfo *exception)
496</pre>
497
498<p>A description of each parameter follows:</p>
499
500<h5>cache_view</h5>
501<p>the cache view.</p>
502
503<h5>x,y</h5>
504<p>These values define the offset of the pixel.</p>
505
506<h5>pixel</h5>
507<p>return a pixel at the specified (x,y) location.</p>
508
509<h5>exception</h5>
510<p>return any errors or warnings in this structure.</p>
511
512 </div>
513<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
514<div class="doc-section">
515
516<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>
517
518<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
519
520<pre class="code">
521 MagickBooleanType GetOneCacheViewVirtualMethodPixel(
522 const CacheView *cache_view,
523 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
524 const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
525</pre>
526
527<p>A description of each parameter follows:</p>
528
529<h5>cache_view</h5>
530<p>the cache view.</p>
531
532<h5>virtual_pixel_method</h5>
533<p>the virtual pixel method.</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="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
546<div class="doc-section">
547
548<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>
549
550<p>The format of the QueueCacheViewAuthenticPixels method is:</p>
551
552<pre class="code">
553 PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
554 const ssize_t x,const ssize_t y,const size_t columns,
555 const size_t rows,ExceptionInfo *exception)
556</pre>
557
558<p>A description of each parameter follows:</p>
559
560<h5>cache_view</h5>
561<p>the cache view.</p>
562
563<h5>x,y,columns,rows</h5>
564<p>These values define the perimeter of a region of pixels.</p>
565
566<h5>exception</h5>
567<p>return any errors or warnings in this structure.</p>
568
569 </div>
570<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
571<div class="doc-section">
572
573<p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p>
574
575<p>The format of the SetCacheViewStorageClass method is:</p>
576
577<pre class="code">
578 MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
579 const ClassType storage_class)
580</pre>
581
582<p>A description of each parameter follows:</p>
583
584<h5>cache_view</h5>
585<p>the cache view.</p>
586
587<h5>storage_class</h5>
588<p>the image storage class: PseudoClass or DirectClass.</p>
589
590 </div>
591<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
592<div class="doc-section">
593
594<p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p>
595
596<p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
597
598<pre class="code">
599 MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
600 const VirtualPixelMethod virtual_pixel_method)
601</pre>
602
603<p>A description of each parameter follows:</p>
604
605<h5>cache_view</h5>
606<p>the cache view.</p>
607
608<h5>virtual_pixel_method</h5>
609<p>the virtual pixel method.</p>
610
611 </div>
612<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
613<div class="doc-section">
614
615<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>
616
617<p>The format of the SyncCacheViewAuthenticPixels method is:</p>
618
619<pre class="code">
620 MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
621 ExceptionInfo *exception)
622</pre>
623
624<p>A description of each parameter follows:</p>
625
626<h5>cache_view</h5>
627<p>the cache view.</p>
628
629<h5>exception</h5>
630<p>return any errors or warnings in this structure.</p>
631
632 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]633
634</div>
635
636<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]637 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]638 <span id="linkbar-center">
639 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]640 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]641 </span>
642 <span id="linkbar-east">&nbsp;</span>
643 </div>
644 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]645 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]646 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
647 </div>
648 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]649 <script type="text/javascript">
650 var _gaq = _gaq || [];
651 _gaq.push(['_setAccount', 'UA-17690367-1']);
652 _gaq.push(['_trackPageview']);
653
654 (function() {
655 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
656 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
657 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
658 })();
659 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]660</body>
661</html>