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