granicus.if.org Git - imagemagick/blob - www/api/cache-view.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html version="-//W3C//DTD XHTML 1.1//EN"
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
   8 <head>
   9   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
  10   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
  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="application-name" content="ImageMagick"/>
  16   <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images automagically."/>
  17   <meta name="application-url" content="http://www.imagemagick.org"/>
  18   <meta name="generator" content="PHP"/>
  19   <meta name="keywords" content="magickcore, c, api, for, imagemagick:, cache, views, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
  20   <meta name="rating" content="GENERAL"/>
  21   <meta name="robots" content="INDEX, FOLLOW"/>
  22   <meta name="generator" content="ImageMagick Studio LLC"/>
  23   <meta name="author" content="ImageMagick Studio LLC"/>
  24   <meta name="revisit-after" content="2 DAYS"/>
  25   <meta name="resource-type" content="document"/>
  26   <meta name="copyright" content="Copyright (c) 1999-2013 ImageMagick Studio LLC"/>
  27   <meta name="distribution" content="Global"/>
  28   <link rel="icon" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/wand.png"/>
  29   <link rel="shortcut icon" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/wand.ico"  type="images/x-icon"/>
  30   <link rel="canonical" href="http://www.imagemagick.org" />
  31   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
  32   <!-- Add jQuery library -->
  33   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
  34
  35   <!-- Optionaly include easing and/or mousewheel plugins -->
  36   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
  37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
  38
  39   <!-- Add fancyBox -->
  40   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
  41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
  42
  43   <!-- Optionaly include button and/or thumbnail helpers -->
  44   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
  45   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
  46
  47   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
  48   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
  49   <script type="text/javascript">
  50         $(document).ready(function() {
  51                 $(".fancybox").fancybox();
  52         });
  53   </script>
  54   <!-- ImageMagick style -->
  55   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
  56   <style type="text/css" media="all">
  57     @import url("../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick.css");
  58   </style>
  59 </head>
  60
  61 <body id="www-imagemagick-org">
  62 <div class="titlebar">
  63 <div style="margin: 17px auto; float: left;">
  64   <script type="text/javascript">
  65   <!--
  66     google_ad_client = "pub-3129977114552745";
  67     google_ad_slot = "5439289906";
  68     google_ad_width = 728;
  69     google_ad_height = 90;
  70   //-->
  71   </script>
  72   <script type="text/javascript"
  73     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
  74   </script>
  75 </div>
  76 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">
  77   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/logo.jpg"
  78   alt="ImageMagick Logo"
  79   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
  80 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">
  81   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/sprite.jpg"
  82   alt="ImageMagick Sprite"
  83   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  84 </div>
  85
  86 <div class="westbar">
  87
  88 <div class="menu">
  89   <a title="About ImageMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">About ImageMagick</a>
  90 </div>
  91 <div class="menu">
  92   <a title="Binary Releases" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: MacOS X" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Binary Release: iOS" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#iOS">iOS</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Binary Release: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#windows">Windows</a>
 105 </div>
 106 <div class="sep"></div>
 107 <div class="menu">
 108   <a title="Command-line Tools" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-tools.html">Command-line Tools</a>
 109 </div>
 110 <div class="sub">
 111     <a title="Command-line Tools: Processing" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-processing.html">Processing</a>
 112 </div>
 113 <div class="sub">
 114     <a title="Command-line Tools: Options" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-options.html">Options</a>
 115 </div>
 116 <div class="sub">
 117     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 118 </div>
 119 <div class="menu">
 120   <a title="Program Interfaces" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/api.html">Program Interfaces</a>
 121 </div>
 122 <div class="sub">
 123     <a title="Program Interface: MagickWand" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-wand.html">MagickWand</a>
 124 </div>
 125 <div class="sub">
 126     <a title="Program Interface: MagickCore" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-core.html">MagickCore</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Program Interface: PerlMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/perl-magick.html">PerlMagick</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Program Interface: Magick++" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick++.html">Magick++</a>
 133 </div>
 134 <div class="sep"></div>
 135 <div  class="menu">
 136    <a title="Install from Source" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html">Install from Source</a>
 137 </div>
 138 <div class="sub">
 139     <a title="Install from Source: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#unix">Unix</a>
 140 </div>
 141 <div class="sub">
 142     <a title="Install from Source: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#windows">Windows</a>
 143  </div>
 144 <div class="menu">
 145   <a title="Resources" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/resources.html">Resources</a>
 146 </div>
 147 <div class="menu">
 148   <a title="Architecture" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/architecture.html">Architecture</a>
 149 </div>
 150 <div class="menu">
 151   <a title="Download" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/download.html">Download</a>
 152 </div>
 153 <div class="sep"></div>
 154 <div class="menu">
 155   <a title="Search" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/search.html">Search</a>
 156 </div>
 157 <div class="sep"></div>
 158 <div class="menu">
 159   <a title="Site Map" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sitemap.html">Site Map</a>
 160 </div>
 161 <div  class="sub">
 162   <a title="Site Map: Links" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/links.html">Links</a>
 163 </div>
 164 <div class="sep"></div>
 165 <div class="menu">
 166   <a rel="follow" title="Sponsors" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sponsors.html">Sponsors:</a>
 167
 168   <a href="http://www.networkredux.com"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 169   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
 170 <div class="sponsbox">
 171 <div class="sponsor">
 172   <a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
 173 </div>
 174 <div class="sponsor">
 175   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
 176 </div>
 177 <div class="sponsor">
 178   <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
 179 </div>
 180 <div class="sponsor">
 181   <a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
 182 </div>
 183 <div class="sponsor">
 184   <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
 185 </div>
 186 <div class="sponsor">
 187   <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
 188 </div>
 189 <div class="sponsor">
 190   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
 191 </div>
 192 <div class="sponsor">
 193   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
 194 </div>
 195 <div class="sponsor">
 196    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
 197 </div>
 198 <div class="sponsor">
 199    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
 200 </div>
 201 <div class="sponsor">
 202   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
 203 </div>
 204 <div class="sponsor">
 205   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 206 </div>
 207 <div class="sponsor">
 208    <a rel="follow" title="Sponsor: Notebook Reparatur" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur</a><!-- 2012080100300 atlas-multimedia-->
 209 </div>
 210 <div class="sponsor">
 211    <a rel="follow" title="Sponsor: Web Hosting" href="http://www.hostucan.com">Web Hosting</a><!-- 2012120100150 racent marketing@webhosting...-->
 212 </div>
 213 </div>
 214 </div>
 215 </div>
 216
 217 <div class="eastbar">
 218   <div class="g-plusone" id="gplusone"></div>
 219   <script type="text/javascript">
 220     window.___gcfg = {
 221       lang: 'en-US'
 222     };
 223
 224     (function() {
 225       var po = document.createElement('script');
 226       po.type = 'text/javascript'; po.async = true;
 227       po.src = 'https://apis.google.com/js/plusone.js';
 228       var script = document.getElementsByTagName('script')[0];
 229       script.parentNode.insertBefore(po, script);
 230     })();
 231     var gplusone = document.getElementById("gplusone");
 232     gplusone.setAttribute("data-size","medium");
 233     gplusone.setAttribute("data-count","false");
 234   </script>
 235 </div>
 236
 237 <div class="main">
 238
 239 <h1>Module cache-view Methods</h1>
 240 <p class="navigation-index">[<a href="cache-view.html#AcquireAuthenticCacheView">AcquireAuthenticCacheView</a> &bull; <a href="cache-view.html#AcquireVirtualCacheView">AcquireVirtualCacheView</a> &bull; <a href="cache-view.html#CloneCacheView">CloneCacheView</a> &bull; <a href="cache-view.html#DestroyCacheView">DestroyCacheView</a> &bull; <a href="cache-view.html#GetCacheViewChannels">GetCacheViewChannels</a> &bull; <a href="cache-view.html#GetCacheViewColorspace">GetCacheViewColorspace</a> &bull; <a href="cache-view.html#GetCacheViewException">GetCacheViewException</a> &bull; <a href="cache-view.html#GetCacheViewStorageClass">GetCacheViewStorageClass</a> &bull; <a href="cache-view.html#GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a> &bull; <a href="cache-view.html#GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a> &bull; <a href="cache-view.html#GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a> &bull; <a href="cache-view.html#GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a> &bull; <a href="cache-view.html#GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a> &bull; <a href="cache-view.html#GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a> &bull; <a href="cache-view.html#GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a> &bull; <a href="cache-view.html#GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a> &bull; <a href="cache-view.html#GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a> &bull; <a href="cache-view.html#QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a> &bull; <a href="cache-view.html#SetCacheViewStorageClass">SetCacheViewStorageClass</a> &bull; <a href="cache-view.html#SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a> &bull; <a href="cache-view.html#SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a>]</p>
 241
 242 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireAuthenticCacheView">AcquireAuthenticCacheView</a></h2>
 243 <div class="doc-section">
 244
 245 <p>AcquireAuthenticCacheView() acquires an authentic view into the pixel cache.</p>
 246
 247 <p>The format of the AcquireAuthenticCacheView method is:</p>
 248
 249 <pre class="code">
 250   CacheView *AcquireAuthenticCacheView(const Image *image,
 251     ExceptionInfo *exception)
 252 </pre>
 253
 254 <p>A description of each parameter follows:</p>
 255
 256 <h5>image</h5>
 257 <p>the image.</p>
 258
 259 <h5>exception</h5>
 260 <p>return any errors or warnings in this structure.</p>
 261
 262  </div>
 263 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireVirtualCacheView">AcquireVirtualCacheView</a></h2>
 264 <div class="doc-section">
 265
 266 <p>AcquireVirtualCacheView() acquires a virtual view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p>
 267
 268 <p>The format of the AcquireVirtualCacheView method is:</p>
 269
 270 <pre class="code">
 271   CacheView *AcquireVirtualCacheView(const Image *image,
 272     ExceptionInfo *exception)
 273 </pre>
 274
 275 <p>A description of each parameter follows:</p>
 276
 277 <h5>image</h5>
 278 <p>the image.</p>
 279
 280 <h5>exception</h5>
 281 <p>return any errors or warnings in this structure.</p>
 282
 283  </div>
 284 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="CloneCacheView">CloneCacheView</a></h2>
 285 <div class="doc-section">
 286
 287 <p>CloneCacheView()  makes an exact copy of the specified cache view.</p>
 288
 289 <p>The format of the CloneCacheView method is:</p>
 290
 291 <pre class="code">
 292   CacheView *CloneCacheView(const CacheView *cache_view)
 293 </pre>
 294
 295 <p>A description of each parameter follows:</p>
 296
 297 <h5>cache_view</h5>
 298 <p>the cache view.</p>
 299
 300  </div>
 301 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="DestroyCacheView">DestroyCacheView</a></h2>
 302 <div class="doc-section">
 303
 304 <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireVirtualCacheView().</p>
 305
 306 <p>The format of the DestroyCacheView method is:</p>
 307
 308 <pre class="code">
 309   CacheView *DestroyCacheView(CacheView *cache_view)
 310 </pre>
 311
 312 <p>A description of each parameter follows:</p>
 313
 314 <h5>cache_view</h5>
 315 <p>the cache view.</p>
 316
 317  </div>
 318 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewChannels">GetCacheViewChannels</a></h2>
 319 <div class="doc-section">
 320
 321 <p>GetCacheViewChannels() returns the image pixel channels associated with the specified view.</p>
 322
 323 <p>The format of the GetCacheViewChannels method is:</p>
 324
 325 <pre class="code">
 326   size_t GetCacheViewChannels(const CacheView *cache_view)
 327 </pre>
 328
 329 <p>A description of each parameter follows:</p>
 330
 331 <h5>cache_view</h5>
 332 <p>the cache view.</p>
 333
 334  </div>
 335 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
 336 <div class="doc-section">
 337
 338 <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p>
 339
 340 <p>The format of the GetCacheViewColorspace method is:</p>
 341
 342 <pre class="code">
 343   ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
 344 </pre>
 345
 346 <p>A description of each parameter follows:</p>
 347
 348 <h5>cache_view</h5>
 349 <p>the cache view.</p>
 350
 351  </div>
 352 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewException">GetCacheViewException</a></h2>
 353 <div class="doc-section">
 354
 355 <p>GetCacheViewException() returns the image exception associated with the specified view.</p>
 356
 357 <p>The format of the GetCacheViewException method is:</p>
 358
 359 <pre class="code">
 360   ExceptionInfo GetCacheViewException(const CacheView *cache_view)
 361 </pre>
 362
 363 <p>A description of each parameter follows:</p>
 364
 365 <h5>cache_view</h5>
 366 <p>the cache view.</p>
 367
 368  </div>
 369 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
 370 <div class="doc-section">
 371
 372 <p>GetCacheViewStorageClass() returns the image storage class  associated with the specified view.</p>
 373
 374 <p>The format of the GetCacheViewStorageClass method is:</p>
 375
 376 <pre class="code">
 377   ClassType GetCacheViewStorageClass(const CacheView *cache_view)
 378 </pre>
 379
 380 <p>A description of each parameter follows:</p>
 381
 382 <h5>cache_view</h5>
 383 <p>the cache view.</p>
 384
 385  </div>
 386 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
 387 <div class="doc-section">
 388
 389 <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>
 390
 391 <p>The format of the GetCacheViewAuthenticPixels method is:</p>
 392
 393 <pre class="code">
 394   PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
 395     const ssize_t x,const ssize_t y,const size_t columns,
 396     const size_t rows,ExceptionInfo *exception)
 397 </pre>
 398
 399 <p>A description of each parameter follows:</p>
 400
 401 <h5>cache_view</h5>
 402 <p>the cache view.</p>
 403
 404 <h5>x,y,columns,rows</h5>
 405 <p>These values define the perimeter of a region of pixels.</p>
 406
 407  </div>
 408 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
 409 <div class="doc-section">
 410
 411 <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.</p>
 412
 413 <p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
 414
 415 <pre class="code">
 416   MagickBooleaNType GetOneCacheViewAuthenticPixel(
 417     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 418     Pixelpacket *pixel,ExceptionInfo *exception)
 419 </pre>
 420
 421 <p>A description of each parameter follows:</p>
 422
 423 <h5>cache_view</h5>
 424 <p>the cache view.</p>
 425
 426 <h5>x,y</h5>
 427 <p>These values define the offset of the pixel.</p>
 428
 429 <h5>pixel</h5>
 430 <p>return a pixel at the specified (x,y) location.</p>
 431
 432 <h5>exception</h5>
 433 <p>return any errors or warnings in this structure.</p>
 434
 435  </div>
 436 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
 437 <div class="doc-section">
 438
 439 <p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue().  The indexes are authentic and can be updated.</p>
 440
 441 <p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
 442
 443 <pre class="code">
 444   IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
 445 </pre>
 446
 447 <p>A description of each parameter follows:</p>
 448
 449 <h5>cache_view</h5>
 450 <p>the cache view.</p>
 451
 452  </div>
 453 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
 454 <div class="doc-section">
 455
 456 <p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels().  The pixels are authentic and therefore can be updated.</p>
 457
 458 <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
 459
 460 <pre class="code">
 461   PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
 462 </pre>
 463
 464 <p>A description of each parameter follows:</p>
 465
 466 <h5>cache_view</h5>
 467 <p>the cache view.</p>
 468
 469  </div>
 470 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
 471 <div class="doc-section">
 472
 473 <p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue().  The indexes are virtual and therefore cannot be updated.</p>
 474
 475 <p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
 476
 477 <pre class="code">
 478   const IndexPacket *GetCacheViewVirtualIndexQueue(
 479     const CacheView *cache_view)
 480 </pre>
 481
 482 <p>A description of each parameter follows:</p>
 483
 484 <h5>cache_view</h5>
 485 <p>the cache view.</p>
 486
 487  </div>
 488 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
 489 <div class="doc-section">
 490
 491 <p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels().  The pixels are virtual and therefore cannot be updated.</p>
 492
 493 <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
 494
 495 <pre class="code">
 496   const PixelPacket *GetCacheViewVirtualPixelQueue(
 497     const CacheView *cache_view)
 498 </pre>
 499
 500 <p>A description of each parameter follows:</p>
 501
 502 <h5>cache_view</h5>
 503 <p>the cache view.</p>
 504
 505  </div>
 506 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
 507 <div class="doc-section">
 508
 509 <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>
 510
 511 <p>The format of the GetCacheViewVirtualPixels method is:</p>
 512
 513 <pre class="code">
 514   const PixelPacket *GetCacheViewVirtualPixels(
 515     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 516     const size_t columns,const size_t rows,ExceptionInfo *exception)
 517 </pre>
 518
 519 <p>A description of each parameter follows:</p>
 520
 521 <h5>cache_view</h5>
 522 <p>the cache view.</p>
 523
 524 <h5>x,y,columns,rows</h5>
 525 <p>These values define the perimeter of a region of pixels.</p>
 526
 527 <h5>exception</h5>
 528 <p>return any errors or warnings in this structure.</p>
 529
 530  </div>
 531 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
 532 <div class="doc-section">
 533
 534 <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>
 535
 536 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 537
 538 <pre class="code">
 539   MagickBooleanType GetOneCacheViewVirtualPixel(
 540     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 541     PixelPacket *pixel,ExceptionInfo *exception)
 542 </pre>
 543
 544 <p>A description of each parameter follows:</p>
 545
 546 <h5>cache_view</h5>
 547 <p>the cache view.</p>
 548
 549 <h5>x,y</h5>
 550 <p>These values define the offset of the pixel.</p>
 551
 552 <h5>pixel</h5>
 553 <p>return a pixel at the specified (x,y) location.</p>
 554
 555 <h5>exception</h5>
 556 <p>return any errors or warnings in this structure.</p>
 557
 558  </div>
 559 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
 560 <div class="doc-section">
 561
 562 <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>
 563
 564 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 565
 566 <pre class="code">
 567   MagickBooleanType GetOneCacheViewVirtualMethodPixel(
 568     const CacheView *cache_view,
 569     const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
 570     const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
 571 </pre>
 572
 573 <p>A description of each parameter follows:</p>
 574
 575 <h5>cache_view</h5>
 576 <p>the cache view.</p>
 577
 578 <h5>virtual_pixel_method</h5>
 579 <p>the virtual pixel method.</p>
 580
 581 <h5>x,y</h5>
 582 <p>These values define the offset of the pixel.</p>
 583
 584 <h5>pixel</h5>
 585 <p>return a pixel at the specified (x,y) location.</p>
 586
 587 <h5>exception</h5>
 588 <p>return any errors or warnings in this structure.</p>
 589
 590  </div>
 591 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
 592 <div class="doc-section">
 593
 594 <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>
 595
 596 <p>The format of the QueueCacheViewAuthenticPixels method is:</p>
 597
 598 <pre class="code">
 599   PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
 600     const ssize_t x,const ssize_t y,const size_t columns,
 601     const size_t rows,ExceptionInfo *exception)
 602 </pre>
 603
 604 <p>A description of each parameter follows:</p>
 605
 606 <h5>cache_view</h5>
 607 <p>the cache view.</p>
 608
 609 <h5>x,y,columns,rows</h5>
 610 <p>These values define the perimeter of a region of pixels.</p>
 611
 612 <h5>exception</h5>
 613 <p>return any errors or warnings in this structure.</p>
 614
 615  </div>
 616 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
 617 <div class="doc-section">
 618
 619 <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p>
 620
 621 <p>The format of the SetCacheViewStorageClass method is:</p>
 622
 623 <pre class="code">
 624   MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
 625     const ClassType storage_class)
 626 </pre>
 627
 628 <p>A description of each parameter follows:</p>
 629
 630 <h5>cache_view</h5>
 631 <p>the cache view.</p>
 632
 633 <h5>storage_class</h5>
 634 <p>the image storage class: PseudoClass or DirectClass.</p>
 635
 636  </div>
 637 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
 638 <div class="doc-section">
 639
 640 <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p>
 641
 642 <p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
 643
 644 <pre class="code">
 645   MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
 646     const VirtualPixelMethod virtual_pixel_method)
 647 </pre>
 648
 649 <p>A description of each parameter follows:</p>
 650
 651 <h5>cache_view</h5>
 652 <p>the cache view.</p>
 653
 654 <h5>virtual_pixel_method</h5>
 655 <p>the virtual pixel method.</p>
 656
 657  </div>
 658 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
 659 <div class="doc-section">
 660
 661 <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>
 662
 663 <p>The format of the SyncCacheViewAuthenticPixels method is:</p>
 664
 665 <pre class="code">
 666   MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
 667     ExceptionInfo *exception)
 668 </pre>
 669
 670 <p>A description of each parameter follows:</p>
 671
 672 <h5>cache_view</h5>
 673 <p>the cache view.</p>
 674
 675 <h5>exception</h5>
 676 <p>return any errors or warnings in this structure.</p>
 677
 678  </div>
 679
 680 </div>
 681
 682 <div id="linkbar">
 683     <span id="linkbar-west">&nbsp;</span>
 684     <span id="linkbar-center">
 685       <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">Discourse Server</a> &bull;
 686       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
 687     </span>
 688     <span id="linkbar-east">&nbsp;</span>
 689   </div>
 690   <div class="footer">
 691     <span id="footer-west">&copy; 1999-2013 ImageMagick Studio LLC</span>
 692     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
 693   </div>
 694   <div style="clear: both; margin: 0; width: 100%; "></div>
 695   <script type="text/javascript">
 696     var _gaq = _gaq || [];
 697     _gaq.push(['_setAccount', 'UA-17690367-1']);
 698     _gaq.push(['_trackPageview']);
 699
 700     (function() {
 701       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
 702       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
 703       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
 704     })();
 705   </script>
 706 </body>
 707 </html>