Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / de27d7631fa4cbb36c8bde6001d2c522774b3712 / . / www / api / cache-view.html
blob: d9fae831ab364b35f3a4c526ac474ead1828af0f [file] [log] [blame]
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]1
2
3
4
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5<!DOCTYPE html>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]6<html lang="en">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]7<head>
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]8 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]9 <title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title>
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]10 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
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"/>
Cristyce4a3552015-12-14 13:53:35 -0500[diff] [blame]22 <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC"/>
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]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"/>
27 <link rel="stylesheet" href="../css/magick.html"/>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]28</head>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]29<body>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]30<div class="main">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]31<div class="magick-masthead">
32 <div class="container">
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]33 <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle"
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]34 style="display:block"
35 data-ad-client="ca-pub-3129977114552745"
36 data-ad-slot="6345125851"
37 data-ad-format="auto"></ins>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]38 <script>
Cristy542697a2015-10-12 20:10:32 -0400[diff] [blame]39 (adsbygoogle = window.adsbygoogle || []).push({});
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]40 </script>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]41 <nav class="magick-nav">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]42 <a class="magick-nav-item " href="../index.html">Home</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]43 <a class="magick-nav-item " href="../binary-releases.html">Download</a>
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]44 <a class="magick-nav-item " href="../command-line-tools.html">Tools</a>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]45 <a class="magick-nav-item " href="../command-line-processing.html">Command-line</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]46 <a class="magick-nav-item " href="../resources.html">Resources</a>
47 <a class="magick-nav-item " href="api.html">Develop</a>
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]48 <a class="magick-nav-item " href="http://nextgen.imagemagick.org/script/search.php">Search</a>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]49 <a class="magick-nav-item pull-right" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]50 </nav>
51 </div>
52</div>
53<div class="container">
cristy4e638cd2015-05-07 16:47:40 +0000[diff] [blame]54<div class="magick-header">
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]55<p class="text-center"><a href="cache-view.html#AcquireAuthenticCacheView">AcquireAuthenticCacheView</a> &#8226; <a href="cache-view.html#AcquireVirtualCacheView">AcquireVirtualCacheView</a> &#8226; <a href="cache-view.html#CloneCacheView">CloneCacheView</a> &#8226; <a href="cache-view.html#DestroyCacheView">DestroyCacheView</a> &#8226; <a href="cache-view.html#GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a> &#8226; <a href="cache-view.html#GetCacheViewAuthenticMetacontent">GetCacheViewAuthenticMetacontent</a> &#8226; <a href="cache-view.html#GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a> &#8226; <a href="cache-view.html#GetCacheViewColorspace">GetCacheViewColorspace</a> &#8226; <a href="cache-view.html#GetCacheViewImage">GetCacheViewImage</a> &#8226; <a href="cache-view.html#GetCacheViewStorageClass">GetCacheViewStorageClass</a> &#8226; <a href="cache-view.html#GetCacheViewVirtualMetacontent">GetCacheViewVirtualMetacontent</a> &#8226; <a href="cache-view.html#GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a> &#8226; <a href="cache-view.html#GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a> &#8226; <a href="cache-view.html#GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a> &#8226; <a href="cache-view.html#GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a> &#8226; <a href="cache-view.html#GetOneCacheViewVirtualPixelInfo">GetOneCacheViewVirtualPixelInfo</a> &#8226; <a href="cache-view.html#GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a> &#8226; <a href="cache-view.html#QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a> &#8226; <a href="cache-view.html#SetCacheViewStorageClass">SetCacheViewStorageClass</a> &#8226; <a href="cache-view.html#SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a> &#8226; <a href="cache-view.html#SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></p>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]56
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]57<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireAuthenticCacheView">AcquireAuthenticCacheView</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]58
59<p>AcquireAuthenticCacheView() acquires an authentic view into the pixel cache. It always succeeds but may return a warning or informational exception.</p>
60
61<p>The format of the AcquireAuthenticCacheView method is:</p>
62
63<pre class="text">
64CacheView *AcquireAuthenticCacheView(const Image *image,
65 ExceptionInfo *exception)
66</pre>
67
68<p>A description of each parameter follows:</p>
69
70<dd>
71</dd>
72
73<dd> </dd>
74<dl class="dl-horizontal">
75<dt>image</dt>
76<dd>the image. </dd>
77
78<dd> </dd>
79<dt>exception</dt>
80<dd>return any errors or warnings in this structure. </dd>
81
82<dd> </dd>
83</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]84<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireVirtualCacheView">AcquireVirtualCacheView</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]85
86<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>
87
88<p>The format of the AcquireVirtualCacheView method is:</p>
89
90<pre class="text">
91CacheView *AcquireVirtualCacheView(const Image *image,
92 ExceptionInfo *exception)
93</pre>
94
95<p>A description of each parameter follows:</p>
96
97<dd>
98</dd>
99
100<dd> </dd>
101<dl class="dl-horizontal">
102<dt>image</dt>
103<dd>the image. </dd>
104
105<dd> </dd>
106<dt>exception</dt>
107<dd>return any errors or warnings in this structure. </dd>
108
109<dd> </dd>
110</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]111<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="CloneCacheView">CloneCacheView</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]112
113<p>CloneCacheView() makes an exact copy of the specified cache view.</p>
114
115<p>The format of the CloneCacheView method is:</p>
116
117<pre class="text">
118CacheView *CloneCacheView(const CacheView *cache_view)
119</pre>
120
121<p>A description of each parameter follows:</p>
122
123<dd>
124</dd>
125
126<dd> </dd>
127<dl class="dl-horizontal">
128<dt>cache_view</dt>
129<dd>the cache view. </dd>
130
131<dd> </dd>
132</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]133<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="DestroyCacheView">DestroyCacheView</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]134
135<p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p>
136
137<p>The format of the DestroyCacheView method is:</p>
138
139<pre class="text">
140CacheView *DestroyCacheView(CacheView *cache_view)
141</pre>
142
143<p>A description of each parameter follows:</p>
144
145<dd>
146</dd>
147
148<dd> </dd>
149<dl class="dl-horizontal">
150<dt>cache_view</dt>
151<dd>the cache view. </dd>
152
153<dd> </dd>
154</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]155<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]156
157<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>
158
159<p>The format of the GetCacheViewAuthenticPixels method is:</p>
160
161<pre class="text">
162Quantum *GetCacheViewAuthenticPixels(CacheView *cache_view,
163 const ssize_t x,const ssize_t y,const size_t columns,
164 const size_t rows,ExceptionInfo *exception)
165</pre>
166
167<p>A description of each parameter follows:</p>
168
169<dd>
170</dd>
171
172<dd> </dd>
173<dl class="dl-horizontal">
174<dt>cache_view</dt>
175<dd>the cache view. </dd>
176
177<dd> </dd>
178<dt>x,y,columns,rows</dt>
179<dd> These values define the perimeter of a region of pixels. </dd>
180
181<dd> </dd>
182<dt>exception</dt>
183<dd>return any errors or warnings in this structure. </dd>
184
185<dd> </dd>
186</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]187<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticMetacontent">GetCacheViewAuthenticMetacontent</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]188
189<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>
190
191<p>The format of the GetCacheViewAuthenticMetacontent() method is:</p>
192
193<pre class="text">
194void *GetCacheViewAuthenticMetacontent(CacheView *cache_view)
195</pre>
196
197<p>A description of each parameter follows:</p>
198
199<dd>
200</dd>
201
202<dd> </dd>
203<dl class="dl-horizontal">
204<dt>cache_view</dt>
205<dd>the cache view. </dd>
206
207<dd> </dd>
208</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]209<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]210
211<p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be updated.</p>
212
213<p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
214
215<pre class="text">
216Quantum *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
217</pre>
218
219<p>A description of each parameter follows:</p>
220
221<dd>
222</dd>
223
224<dd> </dd>
225<dl class="dl-horizontal">
226<dt>cache_view</dt>
227<dd>the cache view. </dd>
228
229<dd> </dd>
230</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]231<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]232
233<p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p>
234
235<p>The format of the GetCacheViewColorspace method is:</p>
236
237<pre class="text">
238ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
239</pre>
240
241<p>A description of each parameter follows:</p>
242
243<dd>
244</dd>
245
246<dd> </dd>
247<dl class="dl-horizontal">
248<dt>cache_view</dt>
249<dd>the cache view. </dd>
250
251<dd> </dd>
252</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]253<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewImage">GetCacheViewImage</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]254
255<p>GetCacheViewImage() returns the image associated with the specified view.</p>
256
257<p>The format of the GetCacheViewImage method is:</p>
258
259<pre class="text">
260const Image *GetCacheViewImage(const CacheView *cache_view)
261</pre>
262
263<p>A description of each parameter follows:</p>
264
265<dd>
266</dd>
267
268<dd> </dd>
269<dl class="dl-horizontal">
270<dt>cache_view</dt>
271<dd>the cache view. </dd>
272
273<dd> </dd>
274</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]275<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]276
277<p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p>
278
279<p>The format of the GetCacheViewStorageClass method is:</p>
280
281<pre class="text">
282ClassType GetCacheViewStorageClass(const CacheView *cache_view)
283</pre>
284
285<p>A description of each parameter follows:</p>
286
287<dd>
288</dd>
289
290<dd> </dd>
291<dl class="dl-horizontal">
292<dt>cache_view</dt>
293<dd>the cache view. </dd>
294
295<dd> </dd>
296</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]297<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualMetacontent">GetCacheViewVirtualMetacontent</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]298
299<p>GetCacheViewVirtualMetacontent() returns the meta-content corresponding with the last call to GetCacheViewVirtualMetacontent(). The meta-content is virtual and therefore cannot be updated.</p>
300
301<p>The format of the GetCacheViewVirtualMetacontent() method is:</p>
302
303<pre class="text">
304const void *GetCacheViewVirtualMetacontent(
305 const CacheView *cache_view)
306</pre>
307
308<p>A description of each parameter follows:</p>
309
310<dd>
311</dd>
312
313<dd> </dd>
314<dl class="dl-horizontal">
315<dt>cache_view</dt>
316<dd>the cache view. </dd>
317
318<dd> </dd>
319</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]320<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]321
322<p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p>
323
324<p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
325
326<pre class="text">
327const Quantum *GetCacheViewVirtualPixelQueue(
328 const CacheView *cache_view)
329</pre>
330
331<p>A description of each parameter follows:</p>
332
333<dd>
334</dd>
335
336<dd> </dd>
337<dl class="dl-horizontal">
338<dt>cache_view</dt>
339<dd>the cache view. </dd>
340
341<dd> </dd>
342</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]343<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]344
345<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>
346
347<p>The format of the GetCacheViewVirtualPixels method is:</p>
348
349<pre class="text">
350const Quantum *GetCacheViewVirtualPixels(
351 const CacheView *cache_view,const ssize_t x,const ssize_t y,
352 const size_t columns,const size_t rows,ExceptionInfo *exception)
353</pre>
354
355<p>A description of each parameter follows:</p>
356
357<dd>
358</dd>
359
360<dd> </dd>
361<dl class="dl-horizontal">
362<dt>cache_view</dt>
363<dd>the cache view. </dd>
364
365<dd> </dd>
366<dt>x,y,columns,rows</dt>
367<dd> These values define the perimeter of a region of pixels. </dd>
368
369<dd> </dd>
370<dt>exception</dt>
371<dd>return any errors or warnings in this structure. </dd>
372
373<dd> </dd>
374</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]375<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]376
377<p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p>
378
379<p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
380
381<pre class="text">
382MagickBooleaNType GetOneCacheViewAuthenticPixel(
383 const CacheView *cache_view,const ssize_t x,const ssize_t y,
384 Quantum *pixel,ExceptionInfo *exception)
385</pre>
386
387<p>A description of each parameter follows:</p>
388
389<dd>
390</dd>
391
392<dd> </dd>
393<dl class="dl-horizontal">
394<dt>cache_view</dt>
395<dd>the cache view. </dd>
396
397<dd> </dd>
398<dt>x,y</dt>
399<dd> These values define the offset of the pixel. </dd>
400
401<dd> </dd>
402<dt>pixel</dt>
403<dd>return a pixel at the specified (x,y) location. </dd>
404
405<dd> </dd>
406<dt>exception</dt>
407<dd>return any errors or warnings in this structure. </dd>
408
409<dd> </dd>
410</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]411<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]412
413<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>
414
415<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
416
417<pre class="text">
418MagickBooleanType GetOneCacheViewVirtualPixel(
419 const CacheView *cache_view,const ssize_t x,const ssize_t y,
420 Quantum *pixel,ExceptionInfo *exception)
421</pre>
422
423<p>A description of each parameter follows:</p>
424
425<dd>
426</dd>
427
428<dd> </dd>
429<dl class="dl-horizontal">
430<dt>cache_view</dt>
431<dd>the cache view. </dd>
432
433<dd> </dd>
434<dt>x,y</dt>
435<dd> These values define the offset of the pixel. </dd>
436
437<dd> </dd>
438<dt>pixel</dt>
439<dd>return a pixel at the specified (x,y) location. </dd>
440
441<dd> </dd>
442<dt>exception</dt>
443<dd>return any errors or warnings in this structure. </dd>
444
445<dd> </dd>
446</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]447<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixelInfo">GetOneCacheViewVirtualPixelInfo</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]448
449<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>
450
451<p>The format of the GetOneCacheViewVirtualPixelInfo method is:</p>
452
453<pre class="text">
454MagickBooleanType GetOneCacheViewVirtualPixelInfo(
455 const CacheView *cache_view,const ssize_t x,const ssize_t y,
456 PixelInfo *pixel,ExceptionInfo *exception)
457</pre>
458
459<p>A description of each parameter follows:</p>
460
461<dd>
462</dd>
463
464<dd> </dd>
465<dl class="dl-horizontal">
466<dt>cache_view</dt>
467<dd>the cache view. </dd>
468
469<dd> </dd>
470<dt>x,y</dt>
471<dd> These values define the offset of the pixel. </dd>
472
473<dd> </dd>
474<dt>pixel</dt>
475<dd>return a pixel at the specified (x,y) location. </dd>
476
477<dd> </dd>
478<dt>exception</dt>
479<dd>return any errors or warnings in this structure. </dd>
480
481<dd> </dd>
482</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]483<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]484
485<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>
486
487<p>The format of the GetOneCacheViewVirtualPixel method is:</p>
488
489<pre class="text">
490MagickBooleanType GetOneCacheViewVirtualMethodPixel(
491 const CacheView *cache_view,
492 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
493 const ssize_t y,Quantum *pixel,ExceptionInfo *exception)
494</pre>
495
496<p>A description of each parameter follows:</p>
497
498<dd>
499</dd>
500
501<dd> </dd>
502<dl class="dl-horizontal">
503<dt>cache_view</dt>
504<dd>the cache view. </dd>
505
506<dd> </dd>
507<dt>virtual_pixel_method</dt>
508<dd>the virtual pixel method. </dd>
509
510<dd> </dd>
511<dt>x,y</dt>
512<dd> These values define the offset of the pixel. </dd>
513
514<dd> </dd>
515<dt>pixel</dt>
516<dd>return a pixel at the specified (x,y) location. </dd>
517
518<dd> </dd>
519<dt>exception</dt>
520<dd>return any errors or warnings in this structure. </dd>
521
522<dd> </dd>
523</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]524<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]525
526<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>
527
528<p>The format of the QueueCacheViewAuthenticPixels method is:</p>
529
530<pre class="text">
531Quantum *QueueCacheViewAuthenticPixels(CacheView *cache_view,
532 const ssize_t x,const ssize_t y,const size_t columns,
533 const size_t rows,ExceptionInfo *exception)
534</pre>
535
536<p>A description of each parameter follows:</p>
537
538<dd>
539</dd>
540
541<dd> </dd>
542<dl class="dl-horizontal">
543<dt>cache_view</dt>
544<dd>the cache view. </dd>
545
546<dd> </dd>
547<dt>x,y,columns,rows</dt>
548<dd> These values define the perimeter of a region of pixels. </dd>
549
550<dd> </dd>
551<dt>exception</dt>
552<dd>return any errors or warnings in this structure. </dd>
553
554<dd> </dd>
555</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]556<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]557
558<p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p>
559
560<p>The format of the SetCacheViewStorageClass method is:</p>
561
562<pre class="text">
563MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
564 const ClassType storage_class,ExceptionInfo *exception)
565</pre>
566
567<p>A description of each parameter follows:</p>
568
569<dd>
570</dd>
571
572<dd> </dd>
573<dl class="dl-horizontal">
574<dt>cache_view</dt>
575<dd>the cache view. </dd>
576
577<dd> </dd>
578<dt>storage_class</dt>
579<dd>the image storage class: PseudoClass or DirectClass. </dd>
580
581<dd> </dd>
582<dt>exception</dt>
583<dd>return any errors or warnings in this structure. </dd>
584
585<dd> </dd>
586</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]587<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]588
589<p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p>
590
591<p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
592
593<pre class="text">
594MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
595 const VirtualPixelMethod virtual_pixel_method)
596</pre>
597
598<p>A description of each parameter follows:</p>
599
600<dd>
601</dd>
602
603<dd> </dd>
604<dl class="dl-horizontal">
605<dt>cache_view</dt>
606<dd>the cache view. </dd>
607
608<dd> </dd>
609<dt>virtual_pixel_method</dt>
610<dd>the virtual pixel method. </dd>
611
612<dd> </dd>
613</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]614<h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]615
616<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>
617
618<p>The format of the SyncCacheViewAuthenticPixels method is:</p>
619
620<pre class="text">
621MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
622 ExceptionInfo *exception)
623</pre>
624
625<p>A description of each parameter follows:</p>
626
627<dd>
628</dd>
629
630<dd> </dd>
631<dl class="dl-horizontal">
632<dt>cache_view</dt>
633<dd>the cache view. </dd>
634
635<dd> </dd>
636<dt>exception</dt>
637<dd>return any errors or warnings in this structure. </dd>
638
639<dd> </dd>
640</dl>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]641</div>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]642 <footer class="magick-footer">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]643 <p><a href="../support.html">Donate</a> •
644 <a href="../sitemap.html">Sitemap</a> •
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]645 <a href="../links.html">Related</a> •
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]646 <a href="../architecture.html">Architecture</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]647</p>
648 <p><a href="cache-view.html#">Back to top</a> •
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]649 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]650 <a href="http://nextgen.imagemagick.org/script/contact.php">Contact Us</a></p>
Cristyce4a3552015-12-14 13:53:35 -0500[diff] [blame]651 <p><small>© 1999-2015 ImageMagick Studio LLC</small></p>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]652 </footer>
653</div><!-- /.container -->
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]654
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]655 <script src="https://localhost/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]656 <script src="http://nextgen.imagemagick.org/js/magick.html"></script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]657</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]658</body>
cristy5a367e42015-05-05 12:39:18 +0000[diff] [blame]659</html>