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   <title>ImageMagick: MagickCore, C API for ImageMagick: Cache Views</title/>
   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"/>
  11   <meta name="Application-name" content="ImageMagick"/>
  12   <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."/>
  13   <meta name="Application-url" content="http://www.imagemagick.org"/>
  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"/>
  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"/>
  22   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../../images/wand.png"  sizes="32x32"/>
  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"/>\r
  27   <style type="text/css" media="all">\r
  28     @import url("../../www/magick.css");\r
  29   </style>\r
  30 </head>\r
  31 \r
  32 <body id="www-imagemagick-org">\r
  33 <div class="titlebar">\r
  34 <a href="../../index.html">\r
  35   <img src="../../images/script.png" alt="[ImageMagick]"\r
  36   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  37 <a href="http://www.networkredux.com">\r
  38   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  39   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  40 <a href="http://www.imagemagick.org/discourse-server/">\r
  41   <img src="../../images/logo.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 <a href="../../index.html">\r
  44   <img src="../../images/sprite.jpg" alt=""\r
  45   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  46 </div>\r
  47 \r
  48 <div class="westbar">\r
  49 \r
  50 <div class="menu">
  51   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  52 </div>
  53 <div class="sep"></div>\r
  54 <div class="menu">
  55   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  62 </div>
  63 <div class="sub">
  64     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  65 </div>
  66 <div class="sep"></div>\r
  67 <div class="menu">
  68   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  78 </div>
  79 <div class="menu">
  80   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  90 </div>
  91 <div class="sub">
  92     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  93 </div>
  94 <div class="sep"></div>\r
  95 <div  class="menu">
  96    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 103  </div>
 104 <div class="menu">
 105   <a title="Resources" href="../../www/resources.html">Resources</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 109 </div>
 110 <div class="menu">
 111   <a title="Download" href="../../www/download.html">Download</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div class="menu">
 119   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 120 </div>
 121 <div  class="sub">
 122     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 127
 128 <div class="sponsbox">
 129 <div  class="sponsor">
 130    <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 143 </div>
 144 <div  class="sponsor">
 145   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 146 </div>
 147 <div  class="sponsor">
 148   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 149 </div>
 150 <div  class="sponsor">
 151    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 152 </div>
 153 </div>
 154 </div>
 155 </div>\r
 156 \r
 157 <div class="eastbar">\r
 158   <script type="text/javascript">\r
 159   <!--\r
 160     google_ad_client = "pub-3129977114552745";\r
 161     google_ad_slot = "0574824969";\r
 162     google_ad_width = 160;\r
 163     google_ad_height = 600;\r
 164   //-->\r
 165   </script>\r
 166   <script type="text/javascript"\r
 167     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 168   </script>\r
 169 </div>\r
 170 \r
 171 <div class="main">\r
 172 \r
 173 <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>
 174
 175 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 176 _8c.html" target="source" name="AcquireCacheView">AcquireCacheView</a></h2>
 177 <div class="doc-section">
 178
 179 <p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
 180
 181 <p>The format of the AcquireCacheView method is:</p>
 182
 183 <pre class="code">
 184   CacheView *AcquireCacheView(const Image *image)
 185 </pre>
 186
 187 <p>A description of each parameter follows:</p></ol>
 188
 189 <h5>image</h5>
 190 <ol><p>the image.</p></ol>
 191
 192  </div>
 193 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 194 _8c.html" target="source" name="CloneCacheView">CloneCacheView</a></h2>
 195 <div class="doc-section">
 196
 197 <p>CloneCacheView()  makes an exact copy of the specified cache view.</p></ol>
 198
 199 <p>The format of the CloneCacheView method is:</p>
 200
 201 <pre class="code">
 202   CacheView *CloneCacheView(const 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="DestroyCacheView">DestroyCacheView</a></h2>
 213 <div class="doc-section">
 214
 215 <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p></ol>
 216
 217 <p>The format of the DestroyCacheView method is:</p>
 218
 219 <pre class="code">
 220   CacheView *DestroyCacheView(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="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
 231 <div class="doc-section">
 232
 233 <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p></ol>
 234
 235 <p>The format of the GetCacheViewColorspace method is:</p>
 236
 237 <pre class="code">
 238   ColorspaceType GetCacheViewColorspace(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="GetCacheViewException">GetCacheViewException</a></h2>
 249 <div class="doc-section">
 250
 251 <p>GetCacheViewException() returns the image exception associated with the specified view.</p></ol>
 252
 253 <p>The format of the GetCacheViewException method is:</p>
 254
 255 <pre class="code">
 256   ExceptionInfo GetCacheViewException(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="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
 267 <div class="doc-section">
 268
 269 <p>GetCacheViewStorageClass() returns the image storage class  associated with the specified view.</p></ol>
 270
 271 <p>The format of the GetCacheViewStorageClass method is:</p>
 272
 273 <pre class="code">
 274   ClassType GetCacheViewStorageClass(const CacheView *cache_view)
 275 </pre>
 276
 277 <p>A description of each parameter follows:</p></ol>
 278
 279 <h5>cache_view</h5>
 280 <ol><p>the cache view.</p></ol>
 281
 282  </div>
 283 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 284 _8c.html" target="source" name="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
 285 <div class="doc-section">
 286
 287 <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>
 288
 289 <p>The format of the GetCacheViewAuthenticPixels method is:</p>
 290
 291 <pre class="code">
 292   PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
 293     const ssize_t x,const ssize_t y,const size_t columns,
 294     const size_t rows,ExceptionInfo *exception)
 295 </pre>
 296
 297 <p>A description of each parameter follows:</p></ol>
 298
 299 <h5>cache_view</h5>
 300 <ol><p>the cache view.</p></ol>
 301
 302 <h5>x,y,columns,rows</h5>
 303 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 304
 305  </div>
 306 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 307 _8c.html" target="source" name="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
 308 <div class="doc-section">
 309
 310 <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.</p></ol>
 311
 312 <p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
 313
 314 <pre class="code">
 315   MagickBooleaNType GetOneCacheViewAuthenticPixel(
 316     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 317     Pixelpacket *pixel,ExceptionInfo *exception)
 318 </pre>
 319
 320 <p>A description of each parameter follows:</p></ol>
 321
 322 <h5>cache_view</h5>
 323 <ol><p>the cache view.</p></ol>
 324
 325 <h5>x,y</h5>
 326 <ol><p>These values define the offset of the pixel.</p></ol>
 327
 328 <h5>pixel</h5>
 329 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 330
 331 <h5>exception</h5>
 332 <ol><p>return any errors or warnings in this structure.</p></ol>
 333
 334  </div>
 335 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 336 _8c.html" target="source" name="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
 337 <div class="doc-section">
 338
 339 <p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue().  The indexes are authentic and can be updated.</p></ol>
 340
 341 <p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
 342
 343 <pre class="code">
 344   IndexPacket *GetCacheViewAuthenticIndexQueue(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="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
 355 <div class="doc-section">
 356
 357 <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>
 358
 359 <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
 360
 361 <pre class="code">
 362   PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
 363 </pre>
 364
 365 <p>A description of each parameter follows:</p></ol>
 366
 367 <h5>cache_view</h5>
 368 <ol><p>the cache view.</p></ol>
 369
 370  </div>
 371 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 372 _8c.html" target="source" name="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
 373 <div class="doc-section">
 374
 375 <p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue().  The indexes are virtual and therefore cannot be updated.</p></ol>
 376
 377 <p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
 378
 379 <pre class="code">
 380   const IndexPacket *GetCacheViewVirtualIndexQueue(
 381     const CacheView *cache_view)
 382 </pre>
 383
 384 <p>A description of each parameter follows:</p></ol>
 385
 386 <h5>cache_view</h5>
 387 <ol><p>the cache view.</p></ol>
 388
 389  </div>
 390 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 391 _8c.html" target="source" name="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
 392 <div class="doc-section">
 393
 394 <p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels().  The pixels are virtual and therefore cannot be updated.</p></ol>
 395
 396 <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
 397
 398 <pre class="code">
 399   const PixelPacket *GetCacheViewVirtualPixelQueue(
 400     const CacheView *cache_view)
 401 </pre>
 402
 403 <p>A description of each parameter follows:</p></ol>
 404
 405 <h5>cache_view</h5>
 406 <ol><p>the cache view.</p></ol>
 407
 408  </div>
 409 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 410 _8c.html" target="source" name="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
 411 <div class="doc-section">
 412
 413 <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>
 414
 415 <p>The format of the GetCacheViewVirtualPixels method is:</p>
 416
 417 <pre class="code">
 418   const PixelPacket *GetCacheViewVirtualPixels(
 419     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 420     const size_t columns,const size_t rows,ExceptionInfo *exception)
 421 </pre>
 422
 423 <p>A description of each parameter follows:</p></ol>
 424
 425 <h5>cache_view</h5>
 426 <ol><p>the cache view.</p></ol>
 427
 428 <h5>x,y,columns,rows</h5>
 429 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 430
 431 <h5>exception</h5>
 432 <ol><p>return any errors or warnings in this structure.</p></ol>
 433
 434  </div>
 435 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 436 _8c.html" target="source" name="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
 437 <div class="doc-section">
 438
 439 <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>
 440
 441 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 442
 443 <pre class="code">
 444   MagickBooleanType GetOneCacheViewVirtualPixel(
 445     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 446     PixelPacket *pixel,ExceptionInfo *exception)
 447 </pre>
 448
 449 <p>A description of each parameter follows:</p></ol>
 450
 451 <h5>cache_view</h5>
 452 <ol><p>the cache view.</p></ol>
 453
 454 <h5>x,y</h5>
 455 <ol><p>These values define the offset of the pixel.</p></ol>
 456
 457 <h5>pixel</h5>
 458 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 459
 460 <h5>exception</h5>
 461 <ol><p>return any errors or warnings in this structure.</p></ol>
 462
 463  </div>
 464 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 465 _8c.html" target="source" name="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
 466 <div class="doc-section">
 467
 468 <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>
 469
 470 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 471
 472 <pre class="code">
 473   MagickBooleanType GetOneCacheViewVirtualMethodPixel(
 474     const CacheView *cache_view,
 475     const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
 476     const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
 477 </pre>
 478
 479 <p>A description of each parameter follows:</p></ol>
 480
 481 <h5>cache_view</h5>
 482 <ol><p>the cache view.</p></ol>
 483
 484 <h5>virtual_pixel_method</h5>
 485 <ol><p>the virtual pixel method.</p></ol>
 486
 487 <h5>x,y</h5>
 488 <ol><p>These values define the offset of the pixel.</p></ol>
 489
 490 <h5>pixel</h5>
 491 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 492
 493 <h5>exception</h5>
 494 <ol><p>return any errors or warnings in this structure.</p></ol>
 495
 496  </div>
 497 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 498 _8c.html" target="source" name="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
 499 <div class="doc-section">
 500
 501 <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>
 502
 503 <p>The format of the QueueCacheViewAuthenticPixels method is:</p>
 504
 505 <pre class="code">
 506   PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
 507     const ssize_t x,const ssize_t y,const size_t columns,
 508     const size_t rows,ExceptionInfo *exception)
 509 </pre>
 510
 511 <p>A description of each parameter follows:</p></ol>
 512
 513 <h5>cache_view</h5>
 514 <ol><p>the cache view.</p></ol>
 515
 516 <h5>x,y,columns,rows</h5>
 517 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 518
 519 <h5>exception</h5>
 520 <ol><p>return any errors or warnings in this structure.</p></ol>
 521
 522  </div>
 523 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 524 _8c.html" target="source" name="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
 525 <div class="doc-section">
 526
 527 <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p></ol>
 528
 529 <p>The format of the SetCacheViewStorageClass method is:</p>
 530
 531 <pre class="code">
 532   MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
 533     const ClassType storage_class)
 534 </pre>
 535
 536 <p>A description of each parameter follows:</p></ol>
 537
 538 <h5>cache_view</h5>
 539 <ol><p>the cache view.</p></ol>
 540
 541 <h5>storage_class</h5>
 542 <ol><p>the image storage class: PseudoClass or DirectClass.</p></ol>
 543
 544  </div>
 545 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 546 _8c.html" target="source" name="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
 547 <div class="doc-section">
 548
 549 <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p></ol>
 550
 551 <p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
 552
 553 <pre class="code">
 554   MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
 555     const VirtualPixelMethod virtual_pixel_method)
 556 </pre>
 557
 558 <p>A description of each parameter follows:</p></ol>
 559
 560 <h5>cache_view</h5>
 561 <ol><p>the cache view.</p></ol>
 562
 563 <h5>virtual_pixel_method</h5>
 564 <ol><p>the virtual pixel method.</p></ol>
 565
 566  </div>
 567 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 568 _8c.html" target="source" name="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
 569 <div class="doc-section">
 570
 571 <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>
 572
 573 <p>The format of the SyncCacheViewAuthenticPixels method is:</p>
 574
 575 <pre class="code">
 576   MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
 577     ExceptionInfo *exception)
 578 </pre>
 579
 580 <p>A description of each parameter follows:</p></ol>
 581
 582 <h5>cache_view</h5>
 583 <ol><p>the cache view.</p></ol>
 584
 585 <h5>exception</h5>
 586 <ol><p>return any errors or warnings in this structure.</p></ol>
 587
 588  </div>
 589 \r
 590 </div>\r
 591 \r
 592 <div id="linkbar">\r
 593     <span id="linkbar-west">&nbsp;</span>\r
 594     <span id="linkbar-center">\r
 595       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 596       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 597     </span>\r
 598     <span id="linkbar-east">&nbsp;</span>\r
 599   </div>\r
 600   <div class="footer">\r
 601     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 602     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 603   </div>\r
 604   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 605   <script type="text/javascript">\r
 606     var _gaq = _gaq || [];\r
 607     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 608     _gaq.push(['_trackPageview']);\r
 609 \r
 610     (function() {\r
 611       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 612       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 613       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 614     })();\r
 615   </script>\r
 616 </body>\r
 617 </html>\r