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

   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" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   7   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   8   <style type="text/css" media="all">\r
   9     @import url("../../www/magick.css");\r
  10   </style>\r
  11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  12   <title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title>
  13   <meta http-equiv="Content-Language" content="en-US"/>
  14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="Generator" content="PHP"/>
  17   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, cache, views, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  18   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
  19   <meta name="Rating" content="GENERAL"/>
  20   <meta name="Robots" content="INDEX, FOLLOW"/>
  21   <meta name="Generator" content="ImageMagick Studio LLC"/>
  22   <meta name="Author" content="ImageMagick Studio LLC"/>
  23   <meta name="Revisit-after" content="2 DAYS"/>
  24   <meta name="Resource-type" content="document"/>
  25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  26   <meta name="Distribution" content="Global"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../../index.html">\r
  32   <img src="../../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../../index.html">\r
  41   <img src="../../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="eastbar">\r
  46 \r
  47 <div class="menu">
  48   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  53 </div>
  54 <div class="sub">
  55     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  62 </div>
  63 <div class="sep"></div>\r
  64 <div class="menu">
  65   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  66 </div>
  67 <div class="sub">
  68     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  75 </div>
  76 <div class="menu">
  77   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  78 </div>
  79 <div class="sub">
  80     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  90 </div>
  91 <div class="sep"></div>\r
  92 <div  class="menu">
  93    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 100  </div>
 101 <div class="menu">
 102   <a title="Resources" href="../../www/resources.html">Resources</a>
 103 </div>
 104 <div class="menu">
 105   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Download" href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Webdesign" href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20110101000120 -->
 146 </div>
 147 </div>
 148 </div>
 149 \r
 150 \r
 151 </div>\r
 152 \r
 153 <div class="main">\r
 154 \r
 155 <p class="navigation-index">[<a href="#AcquireCacheView">AcquireCacheView</a> &bull; <a href="#CloneCacheView">CloneCacheView</a> &bull; <a href="#DestroyCacheView">DestroyCacheView</a> &bull; <a href="#GetCacheViewColorspace">GetCacheViewColorspace</a> &bull; <a href="#GetCacheViewException">GetCacheViewException</a> &bull; <a href="#GetCacheViewStorageClass">GetCacheViewStorageClass</a> &bull; <a href="#GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a> &bull; <a href="#GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a> &bull; <a href="#GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a> &bull; <a href="#GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a> &bull; <a href="#GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a> &bull; <a href="#GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a> &bull; <a href="#GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a> &bull; <a href="#GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a> &bull; <a href="#GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a> &bull; <a href="#QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a> &bull; <a href="#SetCacheViewStorageClass">SetCacheViewStorageClass</a> &bull; <a href="#SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a> &bull; <a href="#SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a>]</p>
 156
 157 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 158 _8c.html" target="source" name="AcquireCacheView">AcquireCacheView</a></h2>
 159 <div class="doc-section">
 160
 161 <p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
 162
 163 <p>The format of the AcquireCacheView method is:</p>
 164
 165 <pre class="code">
 166   CacheView *AcquireCacheView(const Image *image)
 167 </pre>
 168
 169 <p>A description of each parameter follows:</p></ol>
 170
 171 <h5>image</h5>
 172 <ol><p>the image.</p></ol>
 173
 174  </div>
 175 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 176 _8c.html" target="source" name="CloneCacheView">CloneCacheView</a></h2>
 177 <div class="doc-section">
 178
 179 <p>CloneCacheView()  makes an exact copy of the specified cache view.</p></ol>
 180
 181 <p>The format of the CloneCacheView method is:</p>
 182
 183 <pre class="code">
 184   CacheView *CloneCacheView(const CacheView *cache_view)
 185 </pre>
 186
 187 <p>A description of each parameter follows:</p></ol>
 188
 189 <h5>cache_view</h5>
 190 <ol><p>the cache view.</p></ol>
 191
 192  </div>
 193 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 194 _8c.html" target="source" name="DestroyCacheView">DestroyCacheView</a></h2>
 195 <div class="doc-section">
 196
 197 <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p></ol>
 198
 199 <p>The format of the DestroyCacheView method is:</p>
 200
 201 <pre class="code">
 202   CacheView *DestroyCacheView(CacheView *cache_view)
 203 </pre>
 204
 205 <p>A description of each parameter follows:</p></ol>
 206
 207 <h5>cache_view</h5>
 208 <ol><p>the cache view.</p></ol>
 209
 210  </div>
 211 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 212 _8c.html" target="source" name="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
 213 <div class="doc-section">
 214
 215 <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p></ol>
 216
 217 <p>The format of the GetCacheViewColorspace method is:</p>
 218
 219 <pre class="code">
 220   ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
 221 </pre>
 222
 223 <p>A description of each parameter follows:</p></ol>
 224
 225 <h5>cache_view</h5>
 226 <ol><p>the cache view.</p></ol>
 227
 228  </div>
 229 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 230 _8c.html" target="source" name="GetCacheViewException">GetCacheViewException</a></h2>
 231 <div class="doc-section">
 232
 233 <p>GetCacheViewException() returns the image exception associated with the specified view.</p></ol>
 234
 235 <p>The format of the GetCacheViewException method is:</p>
 236
 237 <pre class="code">
 238   ExceptionInfo GetCacheViewException(const CacheView *cache_view)
 239 </pre>
 240
 241 <p>A description of each parameter follows:</p></ol>
 242
 243 <h5>cache_view</h5>
 244 <ol><p>the cache view.</p></ol>
 245
 246  </div>
 247 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 248 _8c.html" target="source" name="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
 249 <div class="doc-section">
 250
 251 <p>GetCacheViewStorageClass() returns the image storage class  associated with the specified view.</p></ol>
 252
 253 <p>The format of the GetCacheViewStorageClass method is:</p>
 254
 255 <pre class="code">
 256   ClassType GetCacheViewStorageClass(const CacheView *cache_view)
 257 </pre>
 258
 259 <p>A description of each parameter follows:</p></ol>
 260
 261 <h5>cache_view</h5>
 262 <ol><p>the cache view.</p></ol>
 263
 264  </div>
 265 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 266 _8c.html" target="source" name="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
 267 <div class="doc-section">
 268
 269 <p>GetCacheViewAuthenticPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters.   A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
 270
 271 <p>The format of the GetCacheViewAuthenticPixels method is:</p>
 272
 273 <pre class="code">
 274   PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
 275     const ssize_t x,const ssize_t y,const size_t columns,
 276     const size_t rows,ExceptionInfo *exception)
 277 </pre>
 278
 279 <p>A description of each parameter follows:</p></ol>
 280
 281 <h5>cache_view</h5>
 282 <ol><p>the cache view.</p></ol>
 283
 284 <h5>x,y,columns,rows</h5>
 285 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 286
 287  </div>
 288 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 289 _8c.html" target="source" name="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
 290 <div class="doc-section">
 291
 292 <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.</p></ol>
 293
 294 <p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
 295
 296 <pre class="code">
 297   MagickBooleaNType GetOneCacheViewAuthenticPixel(
 298     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 299     Pixelpacket *pixel,ExceptionInfo *exception)
 300 </pre>
 301
 302 <p>A description of each parameter follows:</p></ol>
 303
 304 <h5>cache_view</h5>
 305 <ol><p>the cache view.</p></ol>
 306
 307 <h5>x,y</h5>
 308 <ol><p>These values define the offset of the pixel.</p></ol>
 309
 310 <h5>pixel</h5>
 311 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 312
 313 <h5>exception</h5>
 314 <ol><p>return any errors or warnings in this structure.</p></ol>
 315
 316  </div>
 317 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 318 _8c.html" target="source" name="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
 319 <div class="doc-section">
 320
 321 <p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue().  The indexes are authentic and can be updated.</p></ol>
 322
 323 <p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
 324
 325 <pre class="code">
 326   IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
 327 </pre>
 328
 329 <p>A description of each parameter follows:</p></ol>
 330
 331 <h5>cache_view</h5>
 332 <ol><p>the cache view.</p></ol>
 333
 334  </div>
 335 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 336 _8c.html" target="source" name="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
 337 <div class="doc-section">
 338
 339 <p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels().  The pixels are authentic and therefore can be updated.</p></ol>
 340
 341 <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
 342
 343 <pre class="code">
 344   PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
 345 </pre>
 346
 347 <p>A description of each parameter follows:</p></ol>
 348
 349 <h5>cache_view</h5>
 350 <ol><p>the cache view.</p></ol>
 351
 352  </div>
 353 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 354 _8c.html" target="source" name="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
 355 <div class="doc-section">
 356
 357 <p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue().  The indexes are virtual and therefore cannot be updated.</p></ol>
 358
 359 <p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
 360
 361 <pre class="code">
 362   const IndexPacket *GetCacheViewVirtualIndexQueue(
 363     const CacheView *cache_view)
 364 </pre>
 365
 366 <p>A description of each parameter follows:</p></ol>
 367
 368 <h5>cache_view</h5>
 369 <ol><p>the cache view.</p></ol>
 370
 371  </div>
 372 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 373 _8c.html" target="source" name="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
 374 <div class="doc-section">
 375
 376 <p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels().  The pixels are virtual and therefore cannot be updated.</p></ol>
 377
 378 <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
 379
 380 <pre class="code">
 381   const PixelPacket *GetCacheViewVirtualPixelQueue(
 382     const CacheView *cache_view)
 383 </pre>
 384
 385 <p>A description of each parameter follows:</p></ol>
 386
 387 <h5>cache_view</h5>
 388 <ol><p>the cache view.</p></ol>
 389
 390  </div>
 391 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 392 _8c.html" target="source" name="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
 393 <div class="doc-section">
 394
 395 <p>GetCacheViewVirtualPixels() gets virtual pixels from the in-memory or disk pixel cache as defined by the geometry parameters.   A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
 396
 397 <p>The format of the GetCacheViewVirtualPixels method is:</p>
 398
 399 <pre class="code">
 400   const PixelPacket *GetCacheViewVirtualPixels(
 401     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 402     const size_t columns,const size_t rows,
 403     ExceptionInfo *exception)
 404 </pre>
 405
 406 <p>A description of each parameter follows:</p></ol>
 407
 408 <h5>cache_view</h5>
 409 <ol><p>the cache view.</p></ol>
 410
 411 <h5>x,y,columns,rows</h5>
 412 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 413
 414 <h5>exception</h5>
 415 <ol><p>return any errors or warnings in this structure.</p></ol>
 416
 417  </div>
 418 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 419 _8c.html" target="source" name="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
 420 <div class="doc-section">
 421
 422 <p>GetOneCacheViewVirtualPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.  If you plan to modify the pixel, use GetOneCacheViewAuthenticPixel() instead.</p></ol>
 423
 424 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 425
 426 <pre class="code">
 427   MagickBooleanType GetOneCacheViewVirtualPixel(
 428     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 429     PixelPacket *pixel,ExceptionInfo *exception)
 430 </pre>
 431
 432 <p>A description of each parameter follows:</p></ol>
 433
 434 <h5>cache_view</h5>
 435 <ol><p>the cache view.</p></ol>
 436
 437 <h5>x,y</h5>
 438 <ol><p>These values define the offset of the pixel.</p></ol>
 439
 440 <h5>pixel</h5>
 441 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 442
 443 <h5>exception</h5>
 444 <ol><p>return any errors or warnings in this structure.</p></ol>
 445
 446  </div>
 447 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 448 _8c.html" target="source" name="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
 449 <div class="doc-section">
 450
 451 <p>GetOneCacheViewVirtualMethodPixel() returns a single virtual pixel at the specified (x,y) location.  The image background color is returned if an error occurs.  If you plan to modify the pixel, use GetOneCacheViewAuthenticPixel() instead.</p></ol>
 452
 453 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 454
 455 <pre class="code">
 456   MagickBooleanType GetOneCacheViewVirtualMethodPixel(
 457     const CacheView *cache_view,
 458     const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
 459     const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
 460 </pre>
 461
 462 <p>A description of each parameter follows:</p></ol>
 463
 464 <h5>cache_view</h5>
 465 <ol><p>the cache view.</p></ol>
 466
 467 <h5>virtual_pixel_method</h5>
 468 <ol><p>the virtual pixel method.</p></ol>
 469
 470 <h5>x,y</h5>
 471 <ol><p>These values define the offset of the pixel.</p></ol>
 472
 473 <h5>pixel</h5>
 474 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 475
 476 <h5>exception</h5>
 477 <ol><p>return any errors or warnings in this structure.</p></ol>
 478
 479  </div>
 480 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 481 _8c.html" target="source" name="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
 482 <div class="doc-section">
 483
 484 <p>QueueCacheViewAuthenticPixels() queues authentic pixels from the in-memory or disk pixel cache as defined by the geometry parameters.   A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.</p></ol>
 485
 486 <p>The format of the QueueCacheViewAuthenticPixels method is:</p>
 487
 488 <pre class="code">
 489   PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
 490     const ssize_t x,const ssize_t y,const size_t columns,
 491     const size_t rows,ExceptionInfo *exception)
 492 </pre>
 493
 494 <p>A description of each parameter follows:</p></ol>
 495
 496 <h5>cache_view</h5>
 497 <ol><p>the cache view.</p></ol>
 498
 499 <h5>x,y,columns,rows</h5>
 500 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 501
 502 <h5>exception</h5>
 503 <ol><p>return any errors or warnings in this structure.</p></ol>
 504
 505  </div>
 506 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 507 _8c.html" target="source" name="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
 508 <div class="doc-section">
 509
 510 <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p></ol>
 511
 512 <p>The format of the SetCacheViewStorageClass method is:</p>
 513
 514 <pre class="code">
 515   MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
 516     const ClassType storage_class)
 517 </pre>
 518
 519 <p>A description of each parameter follows:</p></ol>
 520
 521 <h5>cache_view</h5>
 522 <ol><p>the cache view.</p></ol>
 523
 524 <h5>storage_class</h5>
 525 <ol><p>the image storage class: PseudoClass or DirectClass.</p></ol>
 526
 527  </div>
 528 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 529 _8c.html" target="source" name="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
 530 <div class="doc-section">
 531
 532 <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p></ol>
 533
 534 <p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
 535
 536 <pre class="code">
 537   MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
 538     const VirtualPixelMethod virtual_pixel_method)
 539 </pre>
 540
 541 <p>A description of each parameter follows:</p></ol>
 542
 543 <h5>cache_view</h5>
 544 <ol><p>the cache view.</p></ol>
 545
 546 <h5>virtual_pixel_method</h5>
 547 <ol><p>the virtual pixel method.</p></ol>
 548
 549  </div>
 550 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 551 _8c.html" target="source" name="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
 552 <div class="doc-section">
 553
 554 <p>SyncCacheViewAuthenticPixels() saves the cache view pixels to the in-memory or disk cache.  It returns MagickTrue if the pixel region is flushed, otherwise MagickFalse.</p></ol>
 555
 556 <p>The format of the SyncCacheViewAuthenticPixels method is:</p>
 557
 558 <pre class="code">
 559   MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
 560     ExceptionInfo *exception)
 561 </pre>
 562
 563 <p>A description of each parameter follows:</p></ol>
 564
 565 <h5>cache_view</h5>
 566 <ol><p>the cache view.</p></ol>
 567
 568 <h5>exception</h5>
 569 <ol><p>return any errors or warnings in this structure.</p></ol>
 570
 571  </div>
 572 \r
 573 </div>\r
 574 \r
 575 <div id="linkbar">\r
 576  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 577     <span id="linkbar-center">\r
 578       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 579     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 580     </span>\r
 581     <span id="linkbar-east">&nbsp;</span>\r
 582   </div>\r
 583   <div class="footer">\r
 584     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 585     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 586   </div>\r
 587   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 588 </body>\r
 589 </html>\r