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.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
128 <div class="sponsor">
129 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
131 <div class="sponsor">
132 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
134 <div class="sponsor">
135 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
137 <div class="sponsor">
138 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
140 <div class="sponsor">
141 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
151 <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>
153 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
154 _8c.html" target="source" name="AcquireCacheView">AcquireCacheView</a></h2>
155 <div class="doc-section">
157 <p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
159 <p>The format of the AcquireCacheView method is:</p>
162 CacheView *AcquireCacheView(const Image *image)
165 <p>A description of each parameter follows:</p></ol>
168 <ol><p>the image.</p></ol>
171 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
172 _8c.html" target="source" name="CloneCacheView">CloneCacheView</a></h2>
173 <div class="doc-section">
175 <p>CloneCacheView() makes an exact copy of the specified cache view.</p></ol>
177 <p>The format of the CloneCacheView method is:</p>
180 CacheView *CloneCacheView(const CacheView *cache_view)
183 <p>A description of each parameter follows:</p></ol>
186 <ol><p>the cache view.</p></ol>
189 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
190 _8c.html" target="source" name="DestroyCacheView">DestroyCacheView</a></h2>
191 <div class="doc-section">
193 <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p></ol>
195 <p>The format of the DestroyCacheView method is:</p>
198 CacheView *DestroyCacheView(CacheView *cache_view)
201 <p>A description of each parameter follows:</p></ol>
204 <ol><p>the cache view.</p></ol>
207 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
208 _8c.html" target="source" name="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
209 <div class="doc-section">
211 <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p></ol>
213 <p>The format of the GetCacheViewColorspace method is:</p>
216 ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
219 <p>A description of each parameter follows:</p></ol>
222 <ol><p>the cache view.</p></ol>
225 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
226 _8c.html" target="source" name="GetCacheViewException">GetCacheViewException</a></h2>
227 <div class="doc-section">
229 <p>GetCacheViewException() returns the image exception associated with the specified view.</p></ol>
231 <p>The format of the GetCacheViewException method is:</p>
234 ExceptionInfo GetCacheViewException(const CacheView *cache_view)
237 <p>A description of each parameter follows:</p></ol>
240 <ol><p>the cache view.</p></ol>
243 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
244 _8c.html" target="source" name="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
245 <div class="doc-section">
247 <p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p></ol>
249 <p>The format of the GetCacheViewStorageClass method is:</p>
252 ClassType GetCacheViewStorageClass(const CacheView *cache_view)
255 <p>A description of each parameter follows:</p></ol>
258 <ol><p>the cache view.</p></ol>
261 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
262 _8c.html" target="source" name="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
263 <div class="doc-section">
265 <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>
267 <p>The format of the GetCacheViewAuthenticPixels method is:</p>
270 PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
271 const long x,const long y,const unsigned long columns,
272 const unsigned long rows,ExceptionInfo *exception)
275 <p>A description of each parameter follows:</p></ol>
278 <ol><p>the cache view.</p></ol>
280 <h5>x,y,columns,rows</h5>
281 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
284 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
285 _8c.html" target="source" name="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
286 <div class="doc-section">
288 <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p></ol>
290 <p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
293 MagickBooleaNType GetOneCacheViewAuthenticPixel(
294 const CacheView *cache_view,const long x,const long y,
295 Pixelpacket *pixel,ExceptionInfo *exception)
298 <p>A description of each parameter follows:</p></ol>
301 <ol><p>the cache view.</p></ol>
304 <ol><p>These values define the offset of the pixel.</p></ol>
307 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
310 <ol><p>return any errors or warnings in this structure.</p></ol>
313 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
314 _8c.html" target="source" name="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
315 <div class="doc-section">
317 <p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.</p></ol>
319 <p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
322 IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
325 <p>A description of each parameter follows:</p></ol>
328 <ol><p>the cache view.</p></ol>
331 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
332 _8c.html" target="source" name="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
333 <div class="doc-section">
335 <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>
337 <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
340 PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
343 <p>A description of each parameter follows:</p></ol>
346 <ol><p>the cache view.</p></ol>
349 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
350 _8c.html" target="source" name="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
351 <div class="doc-section">
353 <p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.</p></ol>
355 <p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
358 const IndexPacket *GetCacheViewVirtualIndexQueue(
359 const CacheView *cache_view)
362 <p>A description of each parameter follows:</p></ol>
365 <ol><p>the cache view.</p></ol>
368 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
369 _8c.html" target="source" name="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
370 <div class="doc-section">
372 <p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p></ol>
374 <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
377 const PixelPacket *GetCacheViewVirtualPixelQueue(
378 const CacheView *cache_view)
381 <p>A description of each parameter follows:</p></ol>
384 <ol><p>the cache view.</p></ol>
387 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
388 _8c.html" target="source" name="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
389 <div class="doc-section">
391 <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>
393 <p>The format of the GetCacheViewVirtualPixels method is:</p>
396 const PixelPacket *GetCacheViewVirtualPixels(
397 const CacheView *cache_view,const long x,const long y,
398 const unsigned long columns,const unsigned long rows,
399 ExceptionInfo *exception)
402 <p>A description of each parameter follows:</p></ol>
405 <ol><p>the cache view.</p></ol>
407 <h5>x,y,columns,rows</h5>
408 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
411 <ol><p>return any errors or warnings in this structure.</p></ol>
414 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
415 _8c.html" target="source" name="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
416 <div class="doc-section">
418 <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>
420 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
423 MagickBooleanType GetOneCacheViewVirtualPixel(
424 const CacheView *cache_view,const long x,const long y,
425 PixelPacket *pixel,ExceptionInfo *exception)
428 <p>A description of each parameter follows:</p></ol>
431 <ol><p>the cache view.</p></ol>
434 <ol><p>These values define the offset of the pixel.</p></ol>
437 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
440 <ol><p>return any errors or warnings in this structure.</p></ol>
443 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
444 _8c.html" target="source" name="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
445 <div class="doc-section">
447 <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>
449 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
452 MagickBooleanType GetOneCacheViewVirtualMethodPixel(
453 const CacheView *cache_view,
454 const VirtualPixelMethod virtual_pixel_method,const long x,
455 const long y,PixelPacket *pixel,ExceptionInfo *exception)
458 <p>A description of each parameter follows:</p></ol>
461 <ol><p>the cache view.</p></ol>
463 <h5>virtual_pixel_method</h5>
464 <ol><p>the virtual pixel method.</p></ol>
467 <ol><p>These values define the offset of the pixel.</p></ol>
470 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
473 <ol><p>return any errors or warnings in this structure.</p></ol>
476 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
477 _8c.html" target="source" name="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
478 <div class="doc-section">
480 <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>
482 <p>The format of the QueueCacheViewAuthenticPixels method is:</p>
485 PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
486 const long x,const long y,const unsigned long columns,
487 const unsigned long rows,ExceptionInfo *exception)
490 <p>A description of each parameter follows:</p></ol>
493 <ol><p>the cache view.</p></ol>
495 <h5>x,y,columns,rows</h5>
496 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
499 <ol><p>return any errors or warnings in this structure.</p></ol>
502 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
503 _8c.html" target="source" name="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
504 <div class="doc-section">
506 <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p></ol>
508 <p>The format of the SetCacheViewStorageClass method is:</p>
511 MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
512 const ClassType storage_class)
515 <p>A description of each parameter follows:</p></ol>
518 <ol><p>the cache view.</p></ol>
520 <h5>storage_class</h5>
521 <ol><p>the image storage class: PseudoClass or DirectClass.</p></ol>
524 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
525 _8c.html" target="source" name="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
526 <div class="doc-section">
528 <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p></ol>
530 <p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
533 MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
534 const VirtualPixelMethod virtual_pixel_method)
537 <p>A description of each parameter follows:</p></ol>
540 <ol><p>the cache view.</p></ol>
542 <h5>virtual_pixel_method</h5>
543 <ol><p>the virtual pixel method.</p></ol>
546 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
547 _8c.html" target="source" name="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
548 <div class="doc-section">
550 <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>
552 <p>The format of the SyncCacheViewAuthenticPixels method is:</p>
555 MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
556 ExceptionInfo *exception)
559 <p>A description of each parameter follows:</p></ol>
562 <ol><p>the cache view.</p></ol>
565 <ol><p>return any errors or warnings in this structure.</p></ol>
572 <!-- <span id="linkbar-west"> </span> -->
\r
573 <span id="linkbar-center">
\r
574 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
575 <a href="../../www/mailing-list.html">Mailing Lists</a> •
\r
576 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
578 <span id="linkbar-east"> </span>
\r
580 <div class="footer">
\r
581 <span id="footer-west">© 1999-2009 ImageMagick Studio LLC</span>
\r
582 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
584 <div style="clear: both; margin: 0; width: 100%; "></div>
\r