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