cristy | dcca3fa | 2010-12-29 21:50:07 +0000 | [diff] [blame] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
| 2 | "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
|
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 4 | <head>
|
cristy | 3c98a4f | 2010-08-13 20:09:41 +0000 | [diff] [blame] | 5 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
| 6 | <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
|
cristy | ffb69ed | 2010-12-25 00:06:48 +0000 | [diff] [blame] | 7 | <title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 8 | <meta http-equiv="Content-Language" content="en-US"/> |
| 9 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> |
| 10 | <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/> |
cristy | 3c98a4f | 2010-08-13 20:09:41 +0000 | [diff] [blame] | 11 | <meta name="Application-name" content="ImageMagick"/> |
cristy | dcca3fa | 2010-12-29 21:50:07 +0000 | [diff] [blame] | 12 | <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/> |
cristy | 3c98a4f | 2010-08-13 20:09:41 +0000 | [diff] [blame] | 13 | <meta name="Application-url" content="http://www.imagemagick.org"/> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 14 | <meta name="Generator" content="PHP"/> |
| 15 | <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"/> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 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"/> |
cristy | 4103d56 | 2010-12-10 01:38:54 +0000 | [diff] [blame] | 22 | <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 23 | <meta name="Distribution" content="Global"/> |
cristy | dcca3fa | 2010-12-29 21:50:07 +0000 | [diff] [blame] | 24 | <link rel="icon" href="../../images/wand.png"/> |
cristy | 3c98a4f | 2010-08-13 20:09:41 +0000 | [diff] [blame] | 25 | <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/> |
| 26 | <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
|
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 27 | <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
|
cristy | 3c98a4f | 2010-08-13 20:09:41 +0000 | [diff] [blame] | 28 | <style type="text/css" media="all">
|
| 29 | @import url("../../www/magick.css");
|
| 30 | </style>
|
cristy | dcca3fa | 2010-12-29 21:50:07 +0000 | [diff] [blame] | 31 | <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
|
cristy | 361f466 | 2010-12-31 23:02:52 +0000 | [diff] [blame] | 32 | <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
|
| 33 | <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
|
| 34 | <script type="text/javascript">
|
| 35 | $(document).ready(function() {
|
| 36 | $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
|
| 37 | 'transitionIn' : 'elastic',
|
| 38 | 'transitionOut' : 'elastic',
|
| 39 | 'overlayShow' : false,
|
| 40 | 'opacity' : true
|
| 41 | });
|
| 42 | });
|
| 43 | </script>
|
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 44 | </head>
|
| 45 |
|
| 46 | <body id="www-imagemagick-org">
|
| 47 | <div class="titlebar">
|
| 48 | <a href="../../index.html">
|
| 49 | <img src="../../images/script.png" alt="[ImageMagick]"
|
| 50 | style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
|
| 51 | <a href="http://www.networkredux.com">
|
| 52 | <img src="../../images/networkredux.png" alt="[sponsor]"
|
cristy | 5292344 | 2011-01-15 22:54:31 +0000 | [diff] [blame^] | 53 | style="margin-top: 42px; border: 0px; float: left;" /></a>
|
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 54 | <a href="http://www.imagemagick.org/discourse-server/">
|
| 55 | <img src="../../images/logo.jpg" alt=""
|
| 56 | style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
|
| 57 | <a href="../../index.html">
|
| 58 | <img src="../../images/sprite.jpg" alt=""
|
| 59 | style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
|
| 60 | </div>
|
| 61 |
|
cristy | ce69bb0 | 2010-07-27 19:49:46 +0000 | [diff] [blame] | 62 | <div class="westbar">
|
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 63 |
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 64 | <div class="menu"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 65 | <a title="About ImageMagick" href="../../index.html">About ImageMagick</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 66 | </div> |
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 67 | <div class="sep"></div>
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 68 | <div class="menu"> |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 69 | <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a> |
| 70 | </div> |
| 71 | <div class="sub"> |
| 72 | <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a> |
| 73 | </div> |
| 74 | <div class="sub"> |
| 75 | <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a> |
| 76 | </div> |
| 77 | <div class="sub"> |
| 78 | <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a> |
| 79 | </div> |
| 80 | <div class="sep"></div>
|
| 81 | <div class="menu"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 82 | <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 83 | </div> |
| 84 | <div class="sub"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 85 | <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 86 | </div> |
| 87 | <div class="sub"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 88 | <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 89 | </div> |
| 90 | <div class="sub"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 91 | <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 92 | </div> |
| 93 | <div class="menu"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 94 | <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 95 | </div> |
| 96 | <div class="sub"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 97 | <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 98 | </div> |
| 99 | <div class="sub"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 100 | <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 101 | </div> |
| 102 | <div class="sub"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 103 | <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 104 | </div> |
| 105 | <div class="sub"> |
cristy | dcca3fa | 2010-12-29 21:50:07 +0000 | [diff] [blame] | 106 | <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 107 | </div> |
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 108 | <div class="sep"></div>
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 109 | <div class="menu"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 110 | <a title="Install from Source" href="../../www/install-source.html">Install from Source</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 111 | </div> |
| 112 | <div class="sub"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 113 | <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 114 | </div> |
| 115 | <div class="sub"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 116 | <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 117 | </div> |
| 118 | <div class="menu"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 119 | <a title="Resources" href="../../www/resources.html">Resources</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 120 | </div> |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 121 | <div class="menu"> |
| 122 | <a title="Architecture" href="../../www/architecture.html">Architecture</a> |
| 123 | </div> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 124 | <div class="menu"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 125 | <a title="Download" href="../../www/download.html">Download</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 126 | </div> |
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 127 | <div class="sep"></div>
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 128 | <div class="menu"> |
cristy | 5292344 | 2011-01-15 22:54:31 +0000 | [diff] [blame^] | 129 | <a title="Search" href="../../www/search.html">Search</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 130 | </div> |
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 131 | <div class="sep"></div>
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 132 | <div class="menu"> |
cristy | ffb69ed | 2010-12-25 00:06:48 +0000 | [diff] [blame] | 133 | <a title="Site Map" href="../../www/sitemap.html">Site Map</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 134 | </div> |
| 135 | <div class="sub"> |
cristy | ffb69ed | 2010-12-25 00:06:48 +0000 | [diff] [blame] | 136 | <a title="Site Map: Links" href="../../www/links.html">Links</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 137 | </div> |
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 138 | <div class="sep"></div>
|
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 139 | <div class="menu"> |
cristy | 83a272e | 2010-05-07 20:40:35 +0000 | [diff] [blame] | 140 | <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 141 | |
| 142 | <div class="sponsbox"> |
cristy | ec6b475 | 2011-01-08 03:16:23 +0000 | [diff] [blame] | 143 | <div class="sponsor"> |
cristy | 5292344 | 2011-01-15 22:54:31 +0000 | [diff] [blame^] | 144 | <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 --> |
cristy | 7d52cd6 | 2010-10-01 17:26:59 +0000 | [diff] [blame] | 145 | </div> |
| 146 | <div class="sponsor"> |
| 147 | <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 --> |
cristy | 73fd1cd | 2010-09-12 19:14:25 +0000 | [diff] [blame] | 148 | </div> |
| 149 | <div class="sponsor"> |
cristy | c5baf4f | 2010-08-31 15:05:33 +0000 | [diff] [blame] | 150 | <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee--> |
| 151 | </div> |
| 152 | <div class="sponsor"> |
cristy | 851dbce | 2010-08-06 21:40:00 +0000 | [diff] [blame] | 153 | <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter--> |
| 154 | </div> |
cristy | ec6b475 | 2011-01-08 03:16:23 +0000 | [diff] [blame] | 155 | <div class="sponsor"> |
cristy | 5292344 | 2011-01-15 22:54:31 +0000 | [diff] [blame^] | 156 | <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 --> |
cristy | ec6b475 | 2011-01-08 03:16:23 +0000 | [diff] [blame] | 157 | </div> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 158 | </div> |
| 159 | </div> |
cristy | ce69bb0 | 2010-07-27 19:49:46 +0000 | [diff] [blame] | 160 | </div>
|
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 161 |
|
cristy | ce69bb0 | 2010-07-27 19:49:46 +0000 | [diff] [blame] | 162 | <div class="eastbar">
|
| 163 | <script type="text/javascript">
|
| 164 | <!--
|
| 165 | google_ad_client = "pub-3129977114552745";
|
cristy | ce69bb0 | 2010-07-27 19:49:46 +0000 | [diff] [blame] | 166 | google_ad_slot = "0574824969";
|
| 167 | google_ad_width = 160;
|
| 168 | google_ad_height = 600;
|
| 169 | //-->
|
| 170 | </script>
|
| 171 | <script type="text/javascript"
|
| 172 | src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
|
| 173 | </script>
|
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 174 | </div>
|
| 175 |
|
| 176 | <div class="main">
|
| 177 |
|
cristy | 307ba18 | 2010-12-25 01:00:34 +0000 | [diff] [blame] | 178 | <h1>Module cache-view |
| 179 | Methods</h1> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 180 | <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> |
| 181 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 182 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 183 | _8c.html" id="AcquireCacheView">AcquireCacheView</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 184 | <div class="doc-section"> |
| 185 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 186 | <p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 187 | |
| 188 | <p>The format of the AcquireCacheView method is:</p> |
| 189 | |
| 190 | <pre class="code"> |
| 191 | CacheView *AcquireCacheView(const Image *image) |
| 192 | </pre> |
| 193 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 194 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 195 | |
| 196 | <h5>image</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 197 | <p>the image.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 198 | |
| 199 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 200 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 201 | _8c.html" id="CloneCacheView">CloneCacheView</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 202 | <div class="doc-section"> |
| 203 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 204 | <p>CloneCacheView() makes an exact copy of the specified cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 205 | |
| 206 | <p>The format of the CloneCacheView method is:</p> |
| 207 | |
| 208 | <pre class="code"> |
| 209 | CacheView *CloneCacheView(const CacheView *cache_view) |
| 210 | </pre> |
| 211 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 212 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 213 | |
| 214 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 215 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 216 | |
| 217 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 218 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 219 | _8c.html" id="DestroyCacheView">DestroyCacheView</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 220 | <div class="doc-section"> |
| 221 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 222 | <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 223 | |
| 224 | <p>The format of the DestroyCacheView method is:</p> |
| 225 | |
| 226 | <pre class="code"> |
| 227 | CacheView *DestroyCacheView(CacheView *cache_view) |
| 228 | </pre> |
| 229 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 230 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 231 | |
| 232 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 233 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 234 | |
| 235 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 236 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 237 | _8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 238 | <div class="doc-section"> |
| 239 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 240 | <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 241 | |
| 242 | <p>The format of the GetCacheViewColorspace method is:</p> |
| 243 | |
| 244 | <pre class="code"> |
| 245 | ColorspaceType GetCacheViewColorspace(const CacheView *cache_view) |
| 246 | </pre> |
| 247 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 248 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 249 | |
| 250 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 251 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 252 | |
| 253 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 254 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 255 | _8c.html" id="GetCacheViewException">GetCacheViewException</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 256 | <div class="doc-section"> |
| 257 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 258 | <p>GetCacheViewException() returns the image exception associated with the specified view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 259 | |
| 260 | <p>The format of the GetCacheViewException method is:</p> |
| 261 | |
| 262 | <pre class="code"> |
| 263 | ExceptionInfo GetCacheViewException(const CacheView *cache_view) |
| 264 | </pre> |
| 265 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 266 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 267 | |
| 268 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 269 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 270 | |
| 271 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 272 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 273 | _8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 274 | <div class="doc-section"> |
| 275 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 276 | <p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 277 | |
| 278 | <p>The format of the GetCacheViewStorageClass method is:</p> |
| 279 | |
| 280 | <pre class="code"> |
| 281 | ClassType GetCacheViewStorageClass(const CacheView *cache_view) |
| 282 | </pre> |
| 283 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 284 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 285 | |
| 286 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 287 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 288 | |
| 289 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 290 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 291 | _8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 292 | <div class="doc-section"> |
| 293 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 294 | <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> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 295 | |
| 296 | <p>The format of the GetCacheViewAuthenticPixels method is:</p> |
| 297 | |
| 298 | <pre class="code"> |
| 299 | PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view, |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 300 | const ssize_t x,const ssize_t y,const size_t columns, |
| 301 | const size_t rows,ExceptionInfo *exception) |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 302 | </pre> |
| 303 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 304 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 305 | |
| 306 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 307 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 308 | |
| 309 | <h5>x,y,columns,rows</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 310 | <p>These values define the perimeter of a region of pixels.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 311 | |
| 312 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 313 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 314 | _8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 315 | <div class="doc-section"> |
| 316 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 317 | <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 318 | |
| 319 | <p>The format of the GetOneCacheViewAuthenticPixel method is:</p> |
| 320 | |
| 321 | <pre class="code"> |
| 322 | MagickBooleaNType GetOneCacheViewAuthenticPixel( |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 323 | const CacheView *cache_view,const ssize_t x,const ssize_t y, |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 324 | Pixelpacket *pixel,ExceptionInfo *exception) |
| 325 | </pre> |
| 326 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 327 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 328 | |
| 329 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 330 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 331 | |
| 332 | <h5>x,y</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 333 | <p>These values define the offset of the pixel.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 334 | |
| 335 | <h5>pixel</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 336 | <p>return a pixel at the specified (x,y) location.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 337 | |
| 338 | <h5>exception</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 339 | <p>return any errors or warnings in this structure.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 340 | |
| 341 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 342 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 343 | _8c.html" id="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 344 | <div class="doc-section"> |
| 345 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 346 | <p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 347 | |
| 348 | <p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p> |
| 349 | |
| 350 | <pre class="code"> |
| 351 | IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view) |
| 352 | </pre> |
| 353 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 354 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 355 | |
| 356 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 357 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 358 | |
| 359 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 360 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 361 | _8c.html" id="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 362 | <div class="doc-section"> |
| 363 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 364 | <p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be updated.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 365 | |
| 366 | <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p> |
| 367 | |
| 368 | <pre class="code"> |
| 369 | PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view) |
| 370 | </pre> |
| 371 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 372 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 373 | |
| 374 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 375 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 376 | |
| 377 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 378 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 379 | _8c.html" id="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 380 | <div class="doc-section"> |
| 381 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 382 | <p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 383 | |
| 384 | <p>The format of the GetCacheViewVirtualIndexQueue() method is:</p> |
| 385 | |
| 386 | <pre class="code"> |
| 387 | const IndexPacket *GetCacheViewVirtualIndexQueue( |
| 388 | const CacheView *cache_view) |
| 389 | </pre> |
| 390 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 391 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 392 | |
| 393 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 394 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 395 | |
| 396 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 397 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 398 | _8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 399 | <div class="doc-section"> |
| 400 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 401 | <p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 402 | |
| 403 | <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p> |
| 404 | |
| 405 | <pre class="code"> |
| 406 | const PixelPacket *GetCacheViewVirtualPixelQueue( |
| 407 | const CacheView *cache_view) |
| 408 | </pre> |
| 409 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 410 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 411 | |
| 412 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 413 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 414 | |
| 415 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 416 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 417 | _8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 418 | <div class="doc-section"> |
| 419 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 420 | <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> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 421 | |
| 422 | <p>The format of the GetCacheViewVirtualPixels method is:</p> |
| 423 | |
| 424 | <pre class="code"> |
| 425 | const PixelPacket *GetCacheViewVirtualPixels( |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 426 | const CacheView *cache_view,const ssize_t x,const ssize_t y, |
cristy | bc9539a | 2010-08-16 18:06:20 +0000 | [diff] [blame] | 427 | const size_t columns,const size_t rows,ExceptionInfo *exception) |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 428 | </pre> |
| 429 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 430 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 431 | |
| 432 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 433 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 434 | |
| 435 | <h5>x,y,columns,rows</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 436 | <p>These values define the perimeter of a region of pixels.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 437 | |
| 438 | <h5>exception</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 439 | <p>return any errors or warnings in this structure.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 440 | |
| 441 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 442 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 443 | _8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 444 | <div class="doc-section"> |
| 445 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 446 | <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> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 447 | |
| 448 | <p>The format of the GetOneCacheViewVirtualPixel method is:</p> |
| 449 | |
| 450 | <pre class="code"> |
| 451 | MagickBooleanType GetOneCacheViewVirtualPixel( |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 452 | const CacheView *cache_view,const ssize_t x,const ssize_t y, |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 453 | PixelPacket *pixel,ExceptionInfo *exception) |
| 454 | </pre> |
| 455 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 456 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 457 | |
| 458 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 459 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 460 | |
| 461 | <h5>x,y</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 462 | <p>These values define the offset of the pixel.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 463 | |
| 464 | <h5>pixel</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 465 | <p>return a pixel at the specified (x,y) location.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 466 | |
| 467 | <h5>exception</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 468 | <p>return any errors or warnings in this structure.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 469 | |
| 470 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 471 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 472 | _8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 473 | <div class="doc-section"> |
| 474 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 475 | <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> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 476 | |
| 477 | <p>The format of the GetOneCacheViewVirtualPixel method is:</p> |
| 478 | |
| 479 | <pre class="code"> |
| 480 | MagickBooleanType GetOneCacheViewVirtualMethodPixel( |
| 481 | const CacheView *cache_view, |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 482 | const VirtualPixelMethod virtual_pixel_method,const ssize_t x, |
| 483 | const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception) |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 484 | </pre> |
| 485 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 486 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 487 | |
| 488 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 489 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 490 | |
| 491 | <h5>virtual_pixel_method</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 492 | <p>the virtual pixel method.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 493 | |
| 494 | <h5>x,y</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 495 | <p>These values define the offset of the pixel.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 496 | |
| 497 | <h5>pixel</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 498 | <p>return a pixel at the specified (x,y) location.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 499 | |
| 500 | <h5>exception</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 501 | <p>return any errors or warnings in this structure.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 502 | |
| 503 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 504 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 505 | _8c.html" id="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 506 | <div class="doc-section"> |
| 507 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 508 | <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> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 509 | |
| 510 | <p>The format of the QueueCacheViewAuthenticPixels method is:</p> |
| 511 | |
| 512 | <pre class="code"> |
| 513 | PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view, |
cristy | bb50337 | 2010-05-27 20:51:26 +0000 | [diff] [blame] | 514 | const ssize_t x,const ssize_t y,const size_t columns, |
| 515 | const size_t rows,ExceptionInfo *exception) |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 516 | </pre> |
| 517 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 518 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 519 | |
| 520 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 521 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 522 | |
| 523 | <h5>x,y,columns,rows</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 524 | <p>These values define the perimeter of a region of pixels.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 525 | |
| 526 | <h5>exception</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 527 | <p>return any errors or warnings in this structure.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 528 | |
| 529 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 530 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 531 | _8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 532 | <div class="doc-section"> |
| 533 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 534 | <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 535 | |
| 536 | <p>The format of the SetCacheViewStorageClass method is:</p> |
| 537 | |
| 538 | <pre class="code"> |
| 539 | MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view, |
| 540 | const ClassType storage_class) |
| 541 | </pre> |
| 542 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 543 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 544 | |
| 545 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 546 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 547 | |
| 548 | <h5>storage_class</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 549 | <p>the image storage class: PseudoClass or DirectClass.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 550 | |
| 551 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 552 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 553 | _8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 554 | <div class="doc-section"> |
| 555 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 556 | <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 557 | |
| 558 | <p>The format of the SetCacheViewVirtualPixelMethod method is:</p> |
| 559 | |
| 560 | <pre class="code"> |
| 561 | MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view, |
| 562 | const VirtualPixelMethod virtual_pixel_method) |
| 563 | </pre> |
| 564 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 565 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 566 | |
| 567 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 568 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 569 | |
| 570 | <h5>virtual_pixel_method</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 571 | <p>the virtual pixel method.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 572 | |
| 573 | </div> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 574 | <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/cache-view |
| 575 | _8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 576 | <div class="doc-section"> |
| 577 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 578 | <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> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 579 | |
| 580 | <p>The format of the SyncCacheViewAuthenticPixels method is:</p> |
| 581 | |
| 582 | <pre class="code"> |
| 583 | MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view, |
| 584 | ExceptionInfo *exception) |
| 585 | </pre> |
| 586 | |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 587 | <p>A description of each parameter follows:</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 588 | |
| 589 | <h5>cache_view</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 590 | <p>the cache view.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 591 | |
| 592 | <h5>exception</h5> |
cristy | 7a40ba8 | 2011-01-08 20:31:18 +0000 | [diff] [blame] | 593 | <p>return any errors or warnings in this structure.</p> |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 594 | |
| 595 | </div> |
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 596 |
|
| 597 | </div>
|
| 598 |
|
| 599 | <div id="linkbar">
|
cristy | ce69bb0 | 2010-07-27 19:49:46 +0000 | [diff] [blame] | 600 | <span id="linkbar-west"> </span>
|
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 601 | <span id="linkbar-center">
|
| 602 | <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
|
cristy | a890294 | 2010-07-30 00:49:52 +0000 | [diff] [blame] | 603 | <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
|
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 604 | </span>
|
| 605 | <span id="linkbar-east"> </span>
|
| 606 | </div>
|
| 607 | <div class="footer">
|
cristy | 4103d56 | 2010-12-10 01:38:54 +0000 | [diff] [blame] | 608 | <span id="footer-west">© 1999-2011 ImageMagick Studio LLC</span>
|
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 609 | <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
|
| 610 | </div>
|
| 611 | <div style="clear: both; margin: 0; width: 100%; "></div>
|
cristy | a890294 | 2010-07-30 00:49:52 +0000 | [diff] [blame] | 612 | <script type="text/javascript">
|
| 613 | var _gaq = _gaq || [];
|
| 614 | _gaq.push(['_setAccount', 'UA-17690367-1']);
|
| 615 | _gaq.push(['_trackPageview']);
|
| 616 |
|
| 617 | (function() {
|
| 618 | var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
| 619 | ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
| 620 | var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
| 621 | })();
|
| 622 | </script>
|
cristy | 3eaa0ef | 2010-03-06 20:35:26 +0000 | [diff] [blame] | 623 | </body>
|
| 624 | </html>
|