1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
\r
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
\r
5 <meta http-equiv="Content-Type" value="application/xhtml+xml" />
\r
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
\r
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
\r
8 <style type="text/css" media="screen,projection"><!--
\r
9 @import url("../../www/magick.css");
\r
11 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, cache, views, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
18 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
26 <meta name="Distribution" content="Global"/>
29 <body id="www-imagemagick-org">
\r
30 <div class="titlebar">
\r
31 <a href="../../index.html">
\r
32 <img src="../../images/script.png" alt="[ImageMagick]"
\r
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
34 <a href="http://www.networkredux.com">
\r
35 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
37 <a href="http://www.imagemagick.org/discourse-server/">
\r
38 <img src="../../images/logo.jpg" alt=""
\r
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
40 <a href="../../index.html">
\r
41 <img src="../../images/sprite.jpg" alt=""
\r
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
45 <div class="eastbar">
\r
48 <a href="../../index.html">About ImageMagick</a>
50 <div class="sep"></div>
\r
52 <a href="../../www/command-line-tools.html">Command-line Tools</a>
55 <a href="../../www/command-line-processing.html">Processing</a>
58 <a href="../../www/command-line-options.html">Options</a>
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
64 <a href="../../www/api.html">Program Interfaces</a>
67 <a href="../../www/magick-wand.html">MagickWand</a>
70 <a href="../../www/magick-core.html">MagickCore</a>
73 <a href="../../www/perl-magick.html">PerlMagick</a>
76 <a href="../../Magick++/">Magick++</a>
79 <a href="../../www/architecture.html">Architecture</a>
81 <div class="sep"></div>
\r
83 <a href="../../www/install-source.html">Install from Source</a>
86 <a href="../../www/install-source.html#unix">Unix</a>
89 <a href="../../www/install-source.html#windows">Windows</a>
92 <a href="../../www/binary-releases.html">Binary Releases</a>
95 <a href="../../www/binary-releases.html#unix">Unix</a>
98 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
101 <a href="../../www/binary-releases.html#windows">Windows</a>
104 <a href="../../www/resources.html">Resources</a>
106 <div class="sep"></div>
\r
108 <a href="../../www/download.html">Download</a>
110 <div class="sep"></div>
\r
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
114 <div class="sep"></div>
\r
116 <a href="../../www/sitemap.html">Site Map</a>
119 <a href="../../www/links.html">Links</a>
121 <div class="sep"></div>
\r
123 <a href="../../www/sponsors.html">Sponsors:</a>
125 <div class="sponsbox">
126 <div class="sponsor">
127 <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
129 <div class="sponsor">
130 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
132 <div class="sponsor">
133 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
135 <div class="sponsor">
136 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
138 <div class="sponsor">
139 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
141 <div class="sponsor">
142 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
144 <div class="sponsor">
145 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
147 <div class="sponsor">
148 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
158 <p class="navigation-index">[<a href="#AcquireCacheView">AcquireCacheView</a> • <a href="#CloneCacheView">CloneCacheView</a> • <a href="#DestroyCacheView">DestroyCacheView</a> • <a href="#GetCacheViewColorspace">GetCacheViewColorspace</a> • <a href="#GetCacheViewException">GetCacheViewException</a> • <a href="#GetCacheViewStorageClass">GetCacheViewStorageClass</a> • <a href="#GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a> • <a href="#GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a> • <a href="#GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a> • <a href="#GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a> • <a href="#GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a> • <a href="#GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a> • <a href="#GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a> • <a href="#GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a> • <a href="#GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a> • <a href="#QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a> • <a href="#SetCacheViewStorageClass">SetCacheViewStorageClass</a> • <a href="#SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a> • <a href="#SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a>]</p>
160 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
161 _8c.html" target="source" name="AcquireCacheView">AcquireCacheView</a></h2>
162 <div class="doc-section">
164 <p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
166 <p>The format of the AcquireCacheView method is:</p>
169 CacheView *AcquireCacheView(const Image *image)
172 <p>A description of each parameter follows:</p></ol>
175 <ol><p>the image.</p></ol>
178 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
179 _8c.html" target="source" name="CloneCacheView">CloneCacheView</a></h2>
180 <div class="doc-section">
182 <p>CloneCacheView() makes an exact copy of the specified cache view.</p></ol>
184 <p>The format of the CloneCacheView method is:</p>
187 CacheView *CloneCacheView(const CacheView *cache_view)
190 <p>A description of each parameter follows:</p></ol>
193 <ol><p>the cache view.</p></ol>
196 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
197 _8c.html" target="source" name="DestroyCacheView">DestroyCacheView</a></h2>
198 <div class="doc-section">
200 <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p></ol>
202 <p>The format of the DestroyCacheView method is:</p>
205 CacheView *DestroyCacheView(CacheView *cache_view)
208 <p>A description of each parameter follows:</p></ol>
211 <ol><p>the cache view.</p></ol>
214 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
215 _8c.html" target="source" name="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
216 <div class="doc-section">
218 <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p></ol>
220 <p>The format of the GetCacheViewColorspace method is:</p>
223 ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
226 <p>A description of each parameter follows:</p></ol>
229 <ol><p>the cache view.</p></ol>
232 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
233 _8c.html" target="source" name="GetCacheViewException">GetCacheViewException</a></h2>
234 <div class="doc-section">
236 <p>GetCacheViewException() returns the image exception associated with the specified view.</p></ol>
238 <p>The format of the GetCacheViewException method is:</p>
241 ExceptionInfo GetCacheViewException(const CacheView *cache_view)
244 <p>A description of each parameter follows:</p></ol>
247 <ol><p>the cache view.</p></ol>
250 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
251 _8c.html" target="source" name="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
252 <div class="doc-section">
254 <p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p></ol>
256 <p>The format of the GetCacheViewStorageClass method is:</p>
259 ClassType GetCacheViewStorageClass(const CacheView *cache_view)
262 <p>A description of each parameter follows:</p></ol>
265 <ol><p>the cache view.</p></ol>
268 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
269 _8c.html" target="source" name="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
270 <div class="doc-section">
272 <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></ol>
274 <p>The format of the GetCacheViewAuthenticPixels method is:</p>
277 PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
278 const long x,const long y,const unsigned long columns,
279 const unsigned long rows,ExceptionInfo *exception)
282 <p>A description of each parameter follows:</p></ol>
285 <ol><p>the cache view.</p></ol>
287 <h5>x,y,columns,rows</h5>
288 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
291 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
292 _8c.html" target="source" name="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
293 <div class="doc-section">
295 <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
297 <p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
300 MagickBooleaNType GetOneCacheViewAuthenticPixel(
301 const CacheView *cache_view,const long x,const long y,
302 Pixelpacket *pixel,ExceptionInfo *exception)
305 <p>A description of each parameter follows:</p></ol>
308 <ol><p>the cache view.</p></ol>
311 <ol><p>These values define the offset of the pixel.</p></ol>
314 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
317 <ol><p>return any errors or warnings in this structure.</p></ol>
320 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
321 _8c.html" target="source" name="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
322 <div class="doc-section">
324 <p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.</p></ol>
326 <p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
329 IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
332 <p>A description of each parameter follows:</p></ol>
335 <ol><p>the cache view.</p></ol>
338 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
339 _8c.html" target="source" name="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
340 <div class="doc-section">
342 <p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be updated.</p></ol>
344 <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
347 PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
350 <p>A description of each parameter follows:</p></ol>
353 <ol><p>the cache view.</p></ol>
356 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
357 _8c.html" target="source" name="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
358 <div class="doc-section">
360 <p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.</p></ol>
362 <p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
365 const IndexPacket *GetCacheViewVirtualIndexQueue(
366 const CacheView *cache_view)
369 <p>A description of each parameter follows:</p></ol>
372 <ol><p>the cache view.</p></ol>
375 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
376 _8c.html" target="source" name="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
377 <div class="doc-section">
379 <p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p></ol>
381 <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
384 const PixelPacket *GetCacheViewVirtualPixelQueue(
385 const CacheView *cache_view)
388 <p>A description of each parameter follows:</p></ol>
391 <ol><p>the cache view.</p></ol>
394 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
395 _8c.html" target="source" name="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
396 <div class="doc-section">
398 <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></ol>
400 <p>The format of the GetCacheViewVirtualPixels method is:</p>
403 const PixelPacket *GetCacheViewVirtualPixels(
404 const CacheView *cache_view,const long x,const long y,
405 const unsigned long columns,const unsigned long rows,
406 ExceptionInfo *exception)
409 <p>A description of each parameter follows:</p></ol>
412 <ol><p>the cache view.</p></ol>
414 <h5>x,y,columns,rows</h5>
415 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
418 <ol><p>return any errors or warnings in this structure.</p></ol>
421 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
422 _8c.html" target="source" name="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
423 <div class="doc-section">
425 <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></ol>
427 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
430 MagickBooleanType GetOneCacheViewVirtualPixel(
431 const CacheView *cache_view,const long x,const long y,
432 PixelPacket *pixel,ExceptionInfo *exception)
435 <p>A description of each parameter follows:</p></ol>
438 <ol><p>the cache view.</p></ol>
441 <ol><p>These values define the offset of the pixel.</p></ol>
444 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
447 <ol><p>return any errors or warnings in this structure.</p></ol>
450 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
451 _8c.html" target="source" name="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
452 <div class="doc-section">
454 <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></ol>
456 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
459 MagickBooleanType GetOneCacheViewVirtualMethodPixel(
460 const CacheView *cache_view,
461 const VirtualPixelMethod virtual_pixel_method,const long x,
462 const long y,PixelPacket *pixel,ExceptionInfo *exception)
465 <p>A description of each parameter follows:</p></ol>
468 <ol><p>the cache view.</p></ol>
470 <h5>virtual_pixel_method</h5>
471 <ol><p>the virtual pixel method.</p></ol>
474 <ol><p>These values define the offset of the pixel.</p></ol>
477 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
480 <ol><p>return any errors or warnings in this structure.</p></ol>
483 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
484 _8c.html" target="source" name="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
485 <div class="doc-section">
487 <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></ol>
489 <p>The format of the QueueCacheViewAuthenticPixels method is:</p>
492 PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
493 const long x,const long y,const unsigned long columns,
494 const unsigned long rows,ExceptionInfo *exception)
497 <p>A description of each parameter follows:</p></ol>
500 <ol><p>the cache view.</p></ol>
502 <h5>x,y,columns,rows</h5>
503 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
506 <ol><p>return any errors or warnings in this structure.</p></ol>
509 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
510 _8c.html" target="source" name="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
511 <div class="doc-section">
513 <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p></ol>
515 <p>The format of the SetCacheViewStorageClass method is:</p>
518 MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
519 const ClassType storage_class)
522 <p>A description of each parameter follows:</p></ol>
525 <ol><p>the cache view.</p></ol>
527 <h5>storage_class</h5>
528 <ol><p>the image storage class: PseudoClass or DirectClass.</p></ol>
531 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
532 _8c.html" target="source" name="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
533 <div class="doc-section">
535 <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p></ol>
537 <p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
540 MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
541 const VirtualPixelMethod virtual_pixel_method)
544 <p>A description of each parameter follows:</p></ol>
547 <ol><p>the cache view.</p></ol>
549 <h5>virtual_pixel_method</h5>
550 <ol><p>the virtual pixel method.</p></ol>
553 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
554 _8c.html" target="source" name="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
555 <div class="doc-section">
557 <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></ol>
559 <p>The format of the SyncCacheViewAuthenticPixels method is:</p>
562 MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
563 ExceptionInfo *exception)
566 <p>A description of each parameter follows:</p></ol>
569 <ol><p>the cache view.</p></ol>
572 <ol><p>return any errors or warnings in this structure.</p></ol>
579 <!-- <span id="linkbar-west"> </span> -->
\r
580 <span id="linkbar-center">
\r
581 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
582 <a href="../../www/mailing-list.html">Mailing Lists</a> •
\r
583 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
585 <span id="linkbar-east"> </span>
\r
587 <div class="footer">
\r
588 <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
\r
589 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
591 <div style="clear: both; margin: 0; width: 100%; "></div>
\r