Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 44443b9be690ffb2fb66ae9298ad552639994ac0 / . / www / api / cache-view.html
blob: 4917740bb56294a9dd55298c4c3d62dac407f172 [file] [log] [blame]
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html lang="en">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]3<head>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]8 <meta http-equiv="content-language" content="en-US">
9 <meta http-equiv="content-type" content="text/html; charset=utf-8">
10 <meta http-equiv="reply-to" content="magick-users@imagemagick.org">
11 <meta name="application-name" content="ImageMagick">
12 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
13 <meta name="application-url" content="http://www.imagemagick.org">
14 <meta name="generator" content="PHP">
15 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, cache, views, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
16 <meta name="rating" content="GENERAL">
17 <meta name="robots" content="INDEX, FOLLOW">
18 <meta name="generator" content="ImageMagick Studio LLC">
19 <meta name="author" content="ImageMagick Studio LLC">
20 <meta name="revisit-after" content="2 DAYS">
21 <meta name="resource-type" content="document">
22 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC">
23 <meta name="distribution" content="Global">
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
25 <link rel="icon" href="../../images/wand.png">
26 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon">
27 <link rel="stylesheet" href="css/bootstrap.min.css">
28 <link rel="stylesheet" href="css/magick.css">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]29</head>
30
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]31<body>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]32<div class="main">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]33<div class="magick-masthead">
34 <div class="container">
35 <script type="text/javascript">
36 <!--
37 google_ad_client = "pub-3129977114552745";
38 google_ad_slot = "5439289906";
39 google_ad_width = 728;
40 google_ad_height = 90;
41 //-->
42 </script>
43 <center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
44 </script></center>
45 <nav class="magick-nav">
46 <a class="magick-nav-item " href="../../index.html">Home</a>
47 <a class="magick-nav-item " href="../../www/binary-releases.html">Downloads</a>
48 <a class="magick-nav-item " href="../../www/command-line-tools.html">Tools</a>
49 <a class="magick-nav-item " href="../../www/command-line-options.html">Options</a>
50 <a class="magick-nav-item " href="../../www/api.html">Development</a>
51 <a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a>
52 <a class="magick-nav-item navbar-right " href="http://www.imagemagick.org/script/search.php">Search</a>
53 </nav>
54 </div>
55</div>
56<div class="container">
57<p class="text-center"><a href="cache-view.html#AcquireAuthenticCacheView">AcquireAuthenticCacheView</a> • <a href="cache-view.html#AcquireVirtualCacheView">AcquireVirtualCacheView</a> • <a href="cache-view.html#CloneCacheView">CloneCacheView</a> • <a href="cache-view.html#DestroyCacheView">DestroyCacheView</a> • <a href="cache-view.html#GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a> • <a href="cache-view.html#GetCacheViewAuthenticMetacontent">GetCacheViewAuthenticMetacontent</a> • <a href="cache-view.html#GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a> • <a href="cache-view.html#GetCacheViewColorspace">GetCacheViewColorspace</a> • <a href="cache-view.html#GetCacheViewImage">GetCacheViewImage</a> • <a href="cache-view.html#GetCacheViewStorageClass">GetCacheViewStorageClass</a> • <a href="cache-view.html#GetCacheViewVirtualMetacontent">GetCacheViewVirtualMetacontent</a> • <a href="cache-view.html#GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a> • <a href="cache-view.html#GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a> • <a href="cache-view.html#GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a> • <a href="cache-view.html#GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a> • <a href="cache-view.html#GetOneCacheViewVirtualPixelInfo">GetOneCacheViewVirtualPixelInfo</a> • <a href="cache-view.html#GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a> • <a href="cache-view.html#QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a> • <a href="cache-view.html#SetCacheViewStorageClass">SetCacheViewStorageClass</a> • <a href="cache-view.html#SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a> • <a href="cache-view.html#SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></p>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]58
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]59<div class="magick-header">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]60<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireAuthenticCacheView">AcquireAuthenticCacheView</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]61
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]62<p>AcquireAuthenticCacheView() acquires an authentic view into the pixel cache. It always succeeds but may return a warning or informational exception.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]63
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]64<p>The format of the AcquireAuthenticCacheView method is:</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]65
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]66<pre class="text">
67CacheView *AcquireAuthenticCacheView(const Image *image,
68 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]69</pre>
70
71<p>A description of each parameter follows:</p>
72
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]73<dd>
74</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]75
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]76<dd> </dd>
77<dl class="dl-horizontal">
78<dt>image</dt>
79<dd>the image. </dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]80
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]81<dd> </dd>
82<dt>exception</dt>
83<dd>return any errors or warnings in this structure. </dd>
84
85<dd> </dd>
86</dl>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]87<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireVirtualCacheView">AcquireVirtualCacheView</a></h2>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]88
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]89<p>AcquireVirtualCacheView() acquires a virtual view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself. It always succeeds but may return a warning or informational exception.</p>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]90
91<p>The format of the AcquireVirtualCacheView method is:</p>
92
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]93<pre class="text">
94CacheView *AcquireVirtualCacheView(const Image *image,
95 ExceptionInfo *exception)
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]96</pre>
97
98<p>A description of each parameter follows:</p>
99
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]100<dd>
101</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]102
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]103<dd> </dd>
104<dl class="dl-horizontal">
105<dt>image</dt>
106<dd>the image. </dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]107
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]108<dd> </dd>
109<dt>exception</dt>
110<dd>return any errors or warnings in this structure. </dd>
111
112<dd> </dd>
113</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]114<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="CloneCacheView">CloneCacheView</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]115
116<p>CloneCacheView() makes an exact copy of the specified cache view.</p>
117
118<p>The format of the CloneCacheView method is:</p>
119
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]120<pre class="text">
121CacheView *CloneCacheView(const CacheView *cache_view)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]122</pre>
123
124<p>A description of each parameter follows:</p>
125
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]126<dd>
127</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]128
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]129<dd> </dd>
130<dl class="dl-horizontal">
131<dt>cache_view</dt>
132<dd>the cache view. </dd>
133
134<dd> </dd>
135</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]136<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="DestroyCacheView">DestroyCacheView</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]137
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]138<p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]139
140<p>The format of the DestroyCacheView method is:</p>
141
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]142<pre class="text">
143CacheView *DestroyCacheView(CacheView *cache_view)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]144</pre>
145
146<p>A description of each parameter follows:</p>
147
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]148<dd>
149</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]150
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]151<dd> </dd>
152<dl class="dl-horizontal">
153<dt>cache_view</dt>
154<dd>the cache view. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]155
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]156<dd> </dd>
157</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]158<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]159
160<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>
161
162<p>The format of the GetCacheViewAuthenticPixels method is:</p>
163
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]164<pre class="text">
165Quantum *GetCacheViewAuthenticPixels(CacheView *cache_view,
166 const ssize_t x,const ssize_t y,const size_t columns,
167 const size_t rows,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]168</pre>
169
170<p>A description of each parameter follows:</p>
171
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]172<dd>
173</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]174
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]175<dd> </dd>
176<dl class="dl-horizontal">
177<dt>cache_view</dt>
178<dd>the cache view. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]179
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]180<dd> </dd>
181<dt>x,y,columns,rows</dt>
182<dd> These values define the perimeter of a region of pixels. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]183
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]184<dd> </dd>
185<dt>exception</dt>
186<dd>return any errors or warnings in this structure. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]187
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]188<dd> </dd>
189</dl>
190<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticMetacontent">GetCacheViewAuthenticMetacontent</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]191
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]192<p>GetCacheViewAuthenticMetacontent() returns the meta-content corresponding with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticMetacontent(). The meta-content are authentic and can be updated.</p>
193
194<p>The format of the GetCacheViewAuthenticMetacontent() method is:</p>
195
196<pre class="text">
197void *GetCacheViewAuthenticMetacontent(CacheView *cache_view)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]198</pre>
199
200<p>A description of each parameter follows:</p>
201
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]202<dd>
203</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]204
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]205<dd> </dd>
206<dl class="dl-horizontal">
207<dt>cache_view</dt>
208<dd>the cache view. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]209
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]210<dd> </dd>
211</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]212<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]213
214<p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be updated.</p>
215
216<p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
217
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]218<pre class="text">
219Quantum *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]220</pre>
221
222<p>A description of each parameter follows:</p>
223
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]224<dd>
225</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]226
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]227<dd> </dd>
228<dl class="dl-horizontal">
229<dt>cache_view</dt>
230<dd>the cache view. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]231
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]232<dd> </dd>
233</dl>
234<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]235
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]236<p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]237
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]238<p>The format of the GetCacheViewColorspace method is:</p>
239
240<pre class="text">
241ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]242</pre>
243
244<p>A description of each parameter follows:</p>
245
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]246<dd>
247</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]248
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]249<dd> </dd>
250<dl class="dl-horizontal">
251<dt>cache_view</dt>
252<dd>the cache view. </dd>
253
254<dd> </dd>
255</dl>
256<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewImage">GetCacheViewImage</a></h2>
257
258<p>GetCacheViewImage() returns the image associated with the specified view.</p>
259
260<p>The format of the GetCacheViewImage method is:</p>
261
262<pre class="text">
263const Image *GetCacheViewImage(const CacheView *cache_view)
264</pre>
265
266<p>A description of each parameter follows:</p>
267
268<dd>
269</dd>
270
271<dd> </dd>
272<dl class="dl-horizontal">
273<dt>cache_view</dt>
274<dd>the cache view. </dd>
275
276<dd> </dd>
277</dl>
278<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
279
280<p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p>
281
282<p>The format of the GetCacheViewStorageClass method is:</p>
283
284<pre class="text">
285ClassType GetCacheViewStorageClass(const CacheView *cache_view)
286</pre>
287
288<p>A description of each parameter follows:</p>
289
290<dd>
291</dd>
292
293<dd> </dd>
294<dl class="dl-horizontal">
295<dt>cache_view</dt>
296<dd>the cache view. </dd>
297
298<dd> </dd>
299</dl>
300<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualMetacontent">GetCacheViewVirtualMetacontent</a></h2>
301
302<p>GetCacheViewVirtualMetacontent() returns the meta-content corresponding with the last call to GetCacheViewVirtualMetacontent(). The meta-content is virtual and therefore cannot be updated.</p>
303
304<p>The format of the GetCacheViewVirtualMetacontent() method is:</p>
305
306<pre class="text">
307const void *GetCacheViewVirtualMetacontent(
308 const CacheView *cache_view)
309</pre>
310
311<p>A description of each parameter follows:</p>
312
313<dd>
314</dd>
315
316<dd> </dd>
317<dl class="dl-horizontal">
318<dt>cache_view</dt>
319<dd>the cache view. </dd>
320
321<dd> </dd>
322</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]323<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]324
325<p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p>
326
327<p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
328
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]329<pre class="text">
330const Quantum *GetCacheViewVirtualPixelQueue(
331 const CacheView *cache_view)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]332</pre>
333
334<p>A description of each parameter follows:</p>
335
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]336<dd>
337</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]338
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]339<dd> </dd>
340<dl class="dl-horizontal">
341<dt>cache_view</dt>
342<dd>the cache view. </dd>
343
344<dd> </dd>
345</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]346<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]347
348<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>
349
350<p>The format of the GetCacheViewVirtualPixels method is:</p>
351
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]352<pre class="text">
353const Quantum *GetCacheViewVirtualPixels(
354 const CacheView *cache_view,const ssize_t x,const ssize_t y,
355 const size_t columns,const size_t rows,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]356</pre>
357
358<p>A description of each parameter follows:</p>
359
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]360<dd>
361</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]362
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]363<dd> </dd>
364<dl class="dl-horizontal">
365<dt>cache_view</dt>
366<dd>the cache view. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]367
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]368<dd> </dd>
369<dt>x,y,columns,rows</dt>
370<dd> These values define the perimeter of a region of pixels. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]371
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]372<dd> </dd>
373<dt>exception</dt>
374<dd>return any errors or warnings in this structure. </dd>
375
376<dd> </dd>
377</dl>
378<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
379
380<p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p>
381
382<p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
383
384<pre class="text">
385MagickBooleaNType GetOneCacheViewAuthenticPixel(
386 const CacheView *cache_view,const ssize_t x,const ssize_t y,
387 Quantum *pixel,ExceptionInfo *exception)
388</pre>
389
390<p>A description of each parameter follows:</p>
391
392<dd>
393</dd>
394
395<dd> </dd>
396<dl class="dl-horizontal">
397<dt>cache_view</dt>
398<dd>the cache view. </dd>
399
400<dd> </dd>
401<dt>x,y</dt>
402<dd> These values define the offset of the pixel. </dd>
403
404<dd> </dd>
405<dt>pixel</dt>
406<dd>return a pixel at the specified (x,y) location. </dd>
407
408<dd> </dd>
409<dt>exception</dt>
410<dd>return any errors or warnings in this structure. </dd>
411
412<dd> </dd>
413</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]414<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]415
416<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>
417
418<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
419
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]420<pre class="text">
421MagickBooleanType GetOneCacheViewVirtualPixel(
422 const CacheView *cache_view,const ssize_t x,const ssize_t y,
423 Quantum *pixel,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]424</pre>
425
426<p>A description of each parameter follows:</p>
427
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]428<dd>
429</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]430
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]431<dd> </dd>
432<dl class="dl-horizontal">
433<dt>cache_view</dt>
434<dd>the cache view. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]435
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]436<dd> </dd>
437<dt>x,y</dt>
438<dd> These values define the offset of the pixel. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]439
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]440<dd> </dd>
441<dt>pixel</dt>
442<dd>return a pixel at the specified (x,y) location. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]443
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]444<dd> </dd>
445<dt>exception</dt>
446<dd>return any errors or warnings in this structure. </dd>
447
448<dd> </dd>
449</dl>
450<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixelInfo">GetOneCacheViewVirtualPixelInfo</a></h2>
451
452<p>GetOneCacheViewVirtualPixelInfo() 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>
453
454<p>The format of the GetOneCacheViewVirtualPixelInfo method is:</p>
455
456<pre class="text">
457MagickBooleanType GetOneCacheViewVirtualPixelInfo(
458 const CacheView *cache_view,const ssize_t x,const ssize_t y,
459 PixelInfo *pixel,ExceptionInfo *exception)
460</pre>
461
462<p>A description of each parameter follows:</p>
463
464<dd>
465</dd>
466
467<dd> </dd>
468<dl class="dl-horizontal">
469<dt>cache_view</dt>
470<dd>the cache view. </dd>
471
472<dd> </dd>
473<dt>x,y</dt>
474<dd> These values define the offset of the pixel. </dd>
475
476<dd> </dd>
477<dt>pixel</dt>
478<dd>return a pixel at the specified (x,y) location. </dd>
479
480<dd> </dd>
481<dt>exception</dt>
482<dd>return any errors or warnings in this structure. </dd>
483
484<dd> </dd>
485</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]486<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]487
488<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>
489
490<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
491
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]492<pre class="text">
493MagickBooleanType GetOneCacheViewVirtualMethodPixel(
494 const CacheView *cache_view,
495 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
496 const ssize_t y,Quantum *pixel,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]497</pre>
498
499<p>A description of each parameter follows:</p>
500
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]501<dd>
502</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]503
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]504<dd> </dd>
505<dl class="dl-horizontal">
506<dt>cache_view</dt>
507<dd>the cache view. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]508
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]509<dd> </dd>
510<dt>virtual_pixel_method</dt>
511<dd>the virtual pixel method. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]512
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]513<dd> </dd>
514<dt>x,y</dt>
515<dd> These values define the offset of the pixel. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]516
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]517<dd> </dd>
518<dt>pixel</dt>
519<dd>return a pixel at the specified (x,y) location. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]520
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]521<dd> </dd>
522<dt>exception</dt>
523<dd>return any errors or warnings in this structure. </dd>
524
525<dd> </dd>
526</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]527<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]528
529<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>
530
531<p>The format of the QueueCacheViewAuthenticPixels method is:</p>
532
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]533<pre class="text">
534Quantum *QueueCacheViewAuthenticPixels(CacheView *cache_view,
535 const ssize_t x,const ssize_t y,const size_t columns,
536 const size_t rows,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]537</pre>
538
539<p>A description of each parameter follows:</p>
540
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]541<dd>
542</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]543
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]544<dd> </dd>
545<dl class="dl-horizontal">
546<dt>cache_view</dt>
547<dd>the cache view. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]548
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]549<dd> </dd>
550<dt>x,y,columns,rows</dt>
551<dd> These values define the perimeter of a region of pixels. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]552
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]553<dd> </dd>
554<dt>exception</dt>
555<dd>return any errors or warnings in this structure. </dd>
556
557<dd> </dd>
558</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]559<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]560
561<p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p>
562
563<p>The format of the SetCacheViewStorageClass method is:</p>
564
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]565<pre class="text">
566MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
567 const ClassType storage_class,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]568</pre>
569
570<p>A description of each parameter follows:</p>
571
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]572<dd>
573</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]574
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]575<dd> </dd>
576<dl class="dl-horizontal">
577<dt>cache_view</dt>
578<dd>the cache view. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]579
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]580<dd> </dd>
581<dt>storage_class</dt>
582<dd>the image storage class: PseudoClass or DirectClass. </dd>
583
584<dd> </dd>
585<dt>exception</dt>
586<dd>return any errors or warnings in this structure. </dd>
587
588<dd> </dd>
589</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]590<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]591
592<p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p>
593
594<p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
595
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]596<pre class="text">
597MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
598 const VirtualPixelMethod virtual_pixel_method)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]599</pre>
600
601<p>A description of each parameter follows:</p>
602
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]603<dd>
604</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]605
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]606<dd> </dd>
607<dl class="dl-horizontal">
608<dt>cache_view</dt>
609<dd>the cache view. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]610
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]611<dd> </dd>
612<dt>virtual_pixel_method</dt>
613<dd>the virtual pixel method. </dd>
614
615<dd> </dd>
616</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]617<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]618
619<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>
620
621<p>The format of the SyncCacheViewAuthenticPixels method is:</p>
622
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]623<pre class="text">
624MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
625 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]626</pre>
627
628<p>A description of each parameter follows:</p>
629
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]630<dd>
631</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]632
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]633<dd> </dd>
634<dl class="dl-horizontal">
635<dt>cache_view</dt>
636<dd>the cache view. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]637
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]638<dd> </dd>
639<dt>exception</dt>
640<dd>return any errors or warnings in this structure. </dd>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]641
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]642<dd> </dd>
643</dl>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]644</div>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]645 <footer class="magick-footer">
646 <div class="magick-nav-item navbar-left">
647 <a href="../../www/support.html">Donations</a>
648 </div>
649 <div class="magick-nav-item navbar-right">
650 <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a>
651 <noscript>
652 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
653 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>
654 </noscript>
655 </div>
656 <p><a href="../../www/sitemap.html">Sitemap</a> •
657 <a href="../../www/links.html">Related</a> •
658 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> •
659 <a href="http://jqmagick.imagemagick.org/">JqMagick</a> •
660 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
661</p>
662 <p><a href="cache-view.html#">Back to top</a> •
663 <a href="../../www/contact.html">Contact Us</a></p>
664 </footer>
665</div><!-- /.container -->
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]666
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]667 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
668 <script src="../../js/bootstrap.min.js"></script>
669 <script type="text/javascript">
670 /* */
671 (function() {
672 var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
673 s.type = 'text/javascript';
674 s.async = true;
675 s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
676 t.parentNode.insertBefore(s, t);
677 })();
678 /* */
679 </script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]680</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]681</body>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame^]682</html><!-- Magick Cache 4th May 2015 18:56 -->