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

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