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 name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
\r
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
\r
7 <style type="text/css" media="screen,projection"><!--
\r
8 @import url("../../www/magick.css");
\r
10 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
11 <title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title>
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"/>
15 <meta name="Generator" content="PHP"/>
16 <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"/>
17 <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."/>
18 <meta name="Rating" content="GENERAL"/>
19 <meta name="Robots" content="INDEX, FOLLOW"/>
20 <meta name="Generator" content="ImageMagick Studio LLC"/>
21 <meta name="Author" content="ImageMagick Studio LLC"/>
22 <meta name="Revisit-after" content="2 DAYS"/>
23 <meta name="Resource-type" content="document"/>
24 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
25 <meta name="Distribution" content="Global"/>
28 <body id="www-imagemagick-org">
\r
29 <div class="titlebar">
\r
30 <a href="../../index.html">
\r
31 <img src="../../images/script.png" alt="[ImageMagick]"
\r
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
33 <a href="http://www.networkredux.com">
\r
34 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
36 <a href="http://www.imagemagick.org/discourse-server/">
\r
37 <img src="../../images/logo.jpg" alt=""
\r
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
39 <a href="../../index.html">
\r
40 <img src="../../images/sprite.jpg" alt=""
\r
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
44 <div class="eastbar">
\r
47 <a href="../../index.html">About ImageMagick</a>
49 <div class="sep"></div>
\r
51 <a href="../../www/command-line-tools.html">Command-line Tools</a>
54 <a href="../../www/command-line-processing.html">Processing</a>
57 <a href="../../www/command-line-options.html">Options</a>
60 <a href="http://www.imagemagick.org/Usage/">Usage</a>
63 <a href="../../www/api.html">Program Interfaces</a>
66 <a href="../../www/magick-wand.html">MagickWand</a>
69 <a href="../../www/magick-core.html">MagickCore</a>
72 <a href="../../www/perl-magick.html">PerlMagick</a>
75 <a href="../../Magick++/">Magick++</a>
78 <a href="../../www/architecture.html">Architecture</a>
80 <div class="sep"></div>
\r
82 <a href="../../www/install-source.html">Install from Source</a>
85 <a href="../../www/install-source.html#unix">Unix</a>
88 <a href="../../www/install-source.html#windows">Windows</a>
91 <a href="../../www/binary-releases.html">Binary Releases</a>
94 <a href="../../www/binary-releases.html#unix">Unix</a>
97 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
100 <a href="../../www/binary-releases.html#windows">Windows</a>
103 <a href="../../www/resources.html">Resources</a>
105 <div class="sep"></div>
\r
107 <a href="../../www/download.html">Download</a>
109 <div class="sep"></div>
\r
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113 <div class="sep"></div>
\r
115 <a href="../../www/sitemap.html">Site Map</a>
118 <a href="../../www/links.html">Links</a>
120 <div class="sep"></div>
\r
122 <a href="../../www/sponsors.html">Sponsors:</a>
124 <div class="sponsbox">
125 <div class="sponsor">
126 <a href="http://www.buerodruck.de/stempel-service/index.html">Stempel bestellen</a><!-- 200910000035+ -->
128 <div class="sponsor">
129 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
131 <div class="sponsor">
132 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
134 <div class="sponsor">
135 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
137 <div class="sponsor">
138 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
140 <div class="sponsor">
141 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
143 <div class="sponsor">
144 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
154 <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>
156 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
157 _8c.html" target="source" name="AcquireCacheView">AcquireCacheView</a></h2>
158 <div class="doc-section">
160 <p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
162 <p>The format of the AcquireCacheView method is:</p>
165 CacheView *AcquireCacheView(const Image *image)
168 <p>A description of each parameter follows:</p></ol>
171 <ol><p>the image.</p></ol>
174 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
175 _8c.html" target="source" name="CloneCacheView">CloneCacheView</a></h2>
176 <div class="doc-section">
178 <p>CloneCacheView() makes an exact copy of the specified cache view.</p></ol>
180 <p>The format of the CloneCacheView method is:</p>
183 CacheView *CloneCacheView(const CacheView *cache_view)
186 <p>A description of each parameter follows:</p></ol>
189 <ol><p>the cache view.</p></ol>
192 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
193 _8c.html" target="source" name="DestroyCacheView">DestroyCacheView</a></h2>
194 <div class="doc-section">
196 <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p></ol>
198 <p>The format of the DestroyCacheView method is:</p>
201 CacheView *DestroyCacheView(CacheView *cache_view)
204 <p>A description of each parameter follows:</p></ol>
207 <ol><p>the cache view.</p></ol>
210 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
211 _8c.html" target="source" name="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
212 <div class="doc-section">
214 <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p></ol>
216 <p>The format of the GetCacheViewColorspace method is:</p>
219 ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
222 <p>A description of each parameter follows:</p></ol>
225 <ol><p>the cache view.</p></ol>
228 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
229 _8c.html" target="source" name="GetCacheViewException">GetCacheViewException</a></h2>
230 <div class="doc-section">
232 <p>GetCacheViewException() returns the image exception associated with the specified view.</p></ol>
234 <p>The format of the GetCacheViewException method is:</p>
237 ExceptionInfo GetCacheViewException(const CacheView *cache_view)
240 <p>A description of each parameter follows:</p></ol>
243 <ol><p>the cache view.</p></ol>
246 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
247 _8c.html" target="source" name="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
248 <div class="doc-section">
250 <p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p></ol>
252 <p>The format of the GetCacheViewStorageClass method is:</p>
255 ClassType GetCacheViewStorageClass(const CacheView *cache_view)
258 <p>A description of each parameter follows:</p></ol>
261 <ol><p>the cache view.</p></ol>
264 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
265 _8c.html" target="source" name="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
266 <div class="doc-section">
268 <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>
270 <p>The format of the GetCacheViewAuthenticPixels method is:</p>
273 PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
274 const long x,const long y,const unsigned long columns,
275 const unsigned long rows,ExceptionInfo *exception)
278 <p>A description of each parameter follows:</p></ol>
281 <ol><p>the cache view.</p></ol>
283 <h5>x,y,columns,rows</h5>
284 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
287 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
288 _8c.html" target="source" name="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
289 <div class="doc-section">
291 <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
293 <p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
296 MagickBooleaNType GetOneCacheViewAuthenticPixel(
297 const CacheView *cache_view,const long x,const long y,
298 Pixelpacket *pixel,ExceptionInfo *exception)
301 <p>A description of each parameter follows:</p></ol>
304 <ol><p>the cache view.</p></ol>
307 <ol><p>These values define the offset of the pixel.</p></ol>
310 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
313 <ol><p>return any errors or warnings in this structure.</p></ol>
316 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
317 _8c.html" target="source" name="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
318 <div class="doc-section">
320 <p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.</p></ol>
322 <p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
325 IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
328 <p>A description of each parameter follows:</p></ol>
331 <ol><p>the cache view.</p></ol>
334 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
335 _8c.html" target="source" name="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
336 <div class="doc-section">
338 <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>
340 <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
343 PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
346 <p>A description of each parameter follows:</p></ol>
349 <ol><p>the cache view.</p></ol>
352 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
353 _8c.html" target="source" name="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
354 <div class="doc-section">
356 <p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.</p></ol>
358 <p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
361 const IndexPacket *GetCacheViewVirtualIndexQueue(
362 const CacheView *cache_view)
365 <p>A description of each parameter follows:</p></ol>
368 <ol><p>the cache view.</p></ol>
371 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
372 _8c.html" target="source" name="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
373 <div class="doc-section">
375 <p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p></ol>
377 <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
380 const PixelPacket *GetCacheViewVirtualPixelQueue(
381 const CacheView *cache_view)
384 <p>A description of each parameter follows:</p></ol>
387 <ol><p>the cache view.</p></ol>
390 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
391 _8c.html" target="source" name="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
392 <div class="doc-section">
394 <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>
396 <p>The format of the GetCacheViewVirtualPixels method is:</p>
399 const PixelPacket *GetCacheViewVirtualPixels(
400 const CacheView *cache_view,const long x,const long y,
401 const unsigned long columns,const unsigned long rows,
402 ExceptionInfo *exception)
405 <p>A description of each parameter follows:</p></ol>
408 <ol><p>the cache view.</p></ol>
410 <h5>x,y,columns,rows</h5>
411 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
414 <ol><p>return any errors or warnings in this structure.</p></ol>
417 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
418 _8c.html" target="source" name="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
419 <div class="doc-section">
421 <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>
423 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
426 MagickBooleanType GetOneCacheViewVirtualPixel(
427 const CacheView *cache_view,const long x,const long y,
428 PixelPacket *pixel,ExceptionInfo *exception)
431 <p>A description of each parameter follows:</p></ol>
434 <ol><p>the cache view.</p></ol>
437 <ol><p>These values define the offset of the pixel.</p></ol>
440 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
443 <ol><p>return any errors or warnings in this structure.</p></ol>
446 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
447 _8c.html" target="source" name="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
448 <div class="doc-section">
450 <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>
452 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
455 MagickBooleanType GetOneCacheViewVirtualMethodPixel(
456 const CacheView *cache_view,
457 const VirtualPixelMethod virtual_pixel_method,const long x,
458 const long y,PixelPacket *pixel,ExceptionInfo *exception)
461 <p>A description of each parameter follows:</p></ol>
464 <ol><p>the cache view.</p></ol>
466 <h5>virtual_pixel_method</h5>
467 <ol><p>the virtual pixel method.</p></ol>
470 <ol><p>These values define the offset of the pixel.</p></ol>
473 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
476 <ol><p>return any errors or warnings in this structure.</p></ol>
479 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
480 _8c.html" target="source" name="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
481 <div class="doc-section">
483 <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>
485 <p>The format of the QueueCacheViewAuthenticPixels method is:</p>
488 PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
489 const long x,const long y,const unsigned long columns,
490 const unsigned long rows,ExceptionInfo *exception)
493 <p>A description of each parameter follows:</p></ol>
496 <ol><p>the cache view.</p></ol>
498 <h5>x,y,columns,rows</h5>
499 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
502 <ol><p>return any errors or warnings in this structure.</p></ol>
505 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
506 _8c.html" target="source" name="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
507 <div class="doc-section">
509 <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p></ol>
511 <p>The format of the SetCacheViewStorageClass method is:</p>
514 MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
515 const ClassType storage_class)
518 <p>A description of each parameter follows:</p></ol>
521 <ol><p>the cache view.</p></ol>
523 <h5>storage_class</h5>
524 <ol><p>the image storage class: PseudoClass or DirectClass.</p></ol>
527 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
528 _8c.html" target="source" name="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
529 <div class="doc-section">
531 <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p></ol>
533 <p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
536 MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
537 const VirtualPixelMethod virtual_pixel_method)
540 <p>A description of each parameter follows:</p></ol>
543 <ol><p>the cache view.</p></ol>
545 <h5>virtual_pixel_method</h5>
546 <ol><p>the virtual pixel method.</p></ol>
549 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
550 _8c.html" target="source" name="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
551 <div class="doc-section">
553 <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>
555 <p>The format of the SyncCacheViewAuthenticPixels method is:</p>
558 MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
559 ExceptionInfo *exception)
562 <p>A description of each parameter follows:</p></ol>
565 <ol><p>the cache view.</p></ol>
568 <ol><p>return any errors or warnings in this structure.</p></ol>
575 <!-- <span id="linkbar-west"> </span> -->
\r
576 <span id="linkbar-center">
\r
577 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
578 <a href="../../www/mailing-list.html">Mailing Lists</a> •
\r
579 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
581 <span id="linkbar-east"> </span>
\r
583 <div class="footer">
\r
584 <span id="footer-west">© 1999-2009 ImageMagick Studio LLC</span>
\r
585 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
587 <div style="clear: both; margin: 0; width: 100%; "></div>
\r