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="westbar">\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: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 137 </div>
 138 <div  class="sponsor">
 139    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 140 </div>
 141 <div  class="sponsor">
 142    <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
 143 </div>
 144 </div>
 145 </div>
 146 </div>\r
 147 \r
 148 <div class="eastbar">\r
 149   <script type="text/javascript">\r
 150   <!--\r
 151     google_ad_client = "pub-3129977114552745";\r
 152     /* 160x600, created 7/27/10 */\r
 153     google_ad_slot = "0574824969";\r
 154     google_ad_width = 160;\r
 155     google_ad_height = 600;\r
 156   //-->\r
 157   </script>\r
 158   <script type="text/javascript"\r
 159     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 160   </script>\r
 161 </div>\r
 162 \r
 163 <div class="main">\r
 164 \r
 165 <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>
 166
 167 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 168 _8c.html" target="source" name="AcquireCacheView">AcquireCacheView</a></h2>
 169 <div class="doc-section">
 170
 171 <p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p></ol>
 172
 173 <p>The format of the AcquireCacheView method is:</p>
 174
 175 <pre class="code">
 176   CacheView *AcquireCacheView(const Image *image)
 177 </pre>
 178
 179 <p>A description of each parameter follows:</p></ol>
 180
 181 <h5>image</h5>
 182 <ol><p>the image.</p></ol>
 183
 184  </div>
 185 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 186 _8c.html" target="source" name="CloneCacheView">CloneCacheView</a></h2>
 187 <div class="doc-section">
 188
 189 <p>CloneCacheView()  makes an exact copy of the specified cache view.</p></ol>
 190
 191 <p>The format of the CloneCacheView method is:</p>
 192
 193 <pre class="code">
 194   CacheView *CloneCacheView(const CacheView *cache_view)
 195 </pre>
 196
 197 <p>A description of each parameter follows:</p></ol>
 198
 199 <h5>cache_view</h5>
 200 <ol><p>the cache view.</p></ol>
 201
 202  </div>
 203 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 204 _8c.html" target="source" name="DestroyCacheView">DestroyCacheView</a></h2>
 205 <div class="doc-section">
 206
 207 <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p></ol>
 208
 209 <p>The format of the DestroyCacheView method is:</p>
 210
 211 <pre class="code">
 212   CacheView *DestroyCacheView(CacheView *cache_view)
 213 </pre>
 214
 215 <p>A description of each parameter follows:</p></ol>
 216
 217 <h5>cache_view</h5>
 218 <ol><p>the cache view.</p></ol>
 219
 220  </div>
 221 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 222 _8c.html" target="source" name="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
 223 <div class="doc-section">
 224
 225 <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p></ol>
 226
 227 <p>The format of the GetCacheViewColorspace method is:</p>
 228
 229 <pre class="code">
 230   ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
 231 </pre>
 232
 233 <p>A description of each parameter follows:</p></ol>
 234
 235 <h5>cache_view</h5>
 236 <ol><p>the cache view.</p></ol>
 237
 238  </div>
 239 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 240 _8c.html" target="source" name="GetCacheViewException">GetCacheViewException</a></h2>
 241 <div class="doc-section">
 242
 243 <p>GetCacheViewException() returns the image exception associated with the specified view.</p></ol>
 244
 245 <p>The format of the GetCacheViewException method is:</p>
 246
 247 <pre class="code">
 248   ExceptionInfo GetCacheViewException(const CacheView *cache_view)
 249 </pre>
 250
 251 <p>A description of each parameter follows:</p></ol>
 252
 253 <h5>cache_view</h5>
 254 <ol><p>the cache view.</p></ol>
 255
 256  </div>
 257 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 258 _8c.html" target="source" name="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
 259 <div class="doc-section">
 260
 261 <p>GetCacheViewStorageClass() returns the image storage class  associated with the specified view.</p></ol>
 262
 263 <p>The format of the GetCacheViewStorageClass method is:</p>
 264
 265 <pre class="code">
 266   ClassType GetCacheViewStorageClass(const CacheView *cache_view)
 267 </pre>
 268
 269 <p>A description of each parameter follows:</p></ol>
 270
 271 <h5>cache_view</h5>
 272 <ol><p>the cache view.</p></ol>
 273
 274  </div>
 275 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 276 _8c.html" target="source" name="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
 277 <div class="doc-section">
 278
 279 <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>
 280
 281 <p>The format of the GetCacheViewAuthenticPixels method is:</p>
 282
 283 <pre class="code">
 284   PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
 285     const ssize_t x,const ssize_t y,const size_t columns,
 286     const size_t rows,ExceptionInfo *exception)
 287 </pre>
 288
 289 <p>A description of each parameter follows:</p></ol>
 290
 291 <h5>cache_view</h5>
 292 <ol><p>the cache view.</p></ol>
 293
 294 <h5>x,y,columns,rows</h5>
 295 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 296
 297  </div>
 298 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 299 _8c.html" target="source" name="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
 300 <div class="doc-section">
 301
 302 <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.</p></ol>
 303
 304 <p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
 305
 306 <pre class="code">
 307   MagickBooleaNType GetOneCacheViewAuthenticPixel(
 308     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 309     Pixelpacket *pixel,ExceptionInfo *exception)
 310 </pre>
 311
 312 <p>A description of each parameter follows:</p></ol>
 313
 314 <h5>cache_view</h5>
 315 <ol><p>the cache view.</p></ol>
 316
 317 <h5>x,y</h5>
 318 <ol><p>These values define the offset of the pixel.</p></ol>
 319
 320 <h5>pixel</h5>
 321 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 322
 323 <h5>exception</h5>
 324 <ol><p>return any errors or warnings in this structure.</p></ol>
 325
 326  </div>
 327 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 328 _8c.html" target="source" name="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
 329 <div class="doc-section">
 330
 331 <p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue().  The indexes are authentic and can be updated.</p></ol>
 332
 333 <p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
 334
 335 <pre class="code">
 336   IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
 337 </pre>
 338
 339 <p>A description of each parameter follows:</p></ol>
 340
 341 <h5>cache_view</h5>
 342 <ol><p>the cache view.</p></ol>
 343
 344  </div>
 345 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 346 _8c.html" target="source" name="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
 347 <div class="doc-section">
 348
 349 <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>
 350
 351 <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
 352
 353 <pre class="code">
 354   PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
 355 </pre>
 356
 357 <p>A description of each parameter follows:</p></ol>
 358
 359 <h5>cache_view</h5>
 360 <ol><p>the cache view.</p></ol>
 361
 362  </div>
 363 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 364 _8c.html" target="source" name="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
 365 <div class="doc-section">
 366
 367 <p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue().  The indexes are virtual and therefore cannot be updated.</p></ol>
 368
 369 <p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
 370
 371 <pre class="code">
 372   const IndexPacket *GetCacheViewVirtualIndexQueue(
 373     const CacheView *cache_view)
 374 </pre>
 375
 376 <p>A description of each parameter follows:</p></ol>
 377
 378 <h5>cache_view</h5>
 379 <ol><p>the cache view.</p></ol>
 380
 381  </div>
 382 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 383 _8c.html" target="source" name="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
 384 <div class="doc-section">
 385
 386 <p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels().  The pixels are virtual and therefore cannot be updated.</p></ol>
 387
 388 <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
 389
 390 <pre class="code">
 391   const PixelPacket *GetCacheViewVirtualPixelQueue(
 392     const CacheView *cache_view)
 393 </pre>
 394
 395 <p>A description of each parameter follows:</p></ol>
 396
 397 <h5>cache_view</h5>
 398 <ol><p>the cache view.</p></ol>
 399
 400  </div>
 401 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 402 _8c.html" target="source" name="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
 403 <div class="doc-section">
 404
 405 <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>
 406
 407 <p>The format of the GetCacheViewVirtualPixels method is:</p>
 408
 409 <pre class="code">
 410   const PixelPacket *GetCacheViewVirtualPixels(
 411     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 412     const size_t columns,const size_t rows,
 413     ExceptionInfo *exception)
 414 </pre>
 415
 416 <p>A description of each parameter follows:</p></ol>
 417
 418 <h5>cache_view</h5>
 419 <ol><p>the cache view.</p></ol>
 420
 421 <h5>x,y,columns,rows</h5>
 422 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 423
 424 <h5>exception</h5>
 425 <ol><p>return any errors or warnings in this structure.</p></ol>
 426
 427  </div>
 428 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 429 _8c.html" target="source" name="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
 430 <div class="doc-section">
 431
 432 <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>
 433
 434 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 435
 436 <pre class="code">
 437   MagickBooleanType GetOneCacheViewVirtualPixel(
 438     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 439     PixelPacket *pixel,ExceptionInfo *exception)
 440 </pre>
 441
 442 <p>A description of each parameter follows:</p></ol>
 443
 444 <h5>cache_view</h5>
 445 <ol><p>the cache view.</p></ol>
 446
 447 <h5>x,y</h5>
 448 <ol><p>These values define the offset of the pixel.</p></ol>
 449
 450 <h5>pixel</h5>
 451 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 452
 453 <h5>exception</h5>
 454 <ol><p>return any errors or warnings in this structure.</p></ol>
 455
 456  </div>
 457 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 458 _8c.html" target="source" name="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
 459 <div class="doc-section">
 460
 461 <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>
 462
 463 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 464
 465 <pre class="code">
 466   MagickBooleanType GetOneCacheViewVirtualMethodPixel(
 467     const CacheView *cache_view,
 468     const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
 469     const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
 470 </pre>
 471
 472 <p>A description of each parameter follows:</p></ol>
 473
 474 <h5>cache_view</h5>
 475 <ol><p>the cache view.</p></ol>
 476
 477 <h5>virtual_pixel_method</h5>
 478 <ol><p>the virtual pixel method.</p></ol>
 479
 480 <h5>x,y</h5>
 481 <ol><p>These values define the offset of the pixel.</p></ol>
 482
 483 <h5>pixel</h5>
 484 <ol><p>return a pixel at the specified (x,y) location.</p></ol>
 485
 486 <h5>exception</h5>
 487 <ol><p>return any errors or warnings in this structure.</p></ol>
 488
 489  </div>
 490 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 491 _8c.html" target="source" name="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
 492 <div class="doc-section">
 493
 494 <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>
 495
 496 <p>The format of the QueueCacheViewAuthenticPixels method is:</p>
 497
 498 <pre class="code">
 499   PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
 500     const ssize_t x,const ssize_t y,const size_t columns,
 501     const size_t rows,ExceptionInfo *exception)
 502 </pre>
 503
 504 <p>A description of each parameter follows:</p></ol>
 505
 506 <h5>cache_view</h5>
 507 <ol><p>the cache view.</p></ol>
 508
 509 <h5>x,y,columns,rows</h5>
 510 <ol><p>These values define the perimeter of a region of pixels.</p></ol>
 511
 512 <h5>exception</h5>
 513 <ol><p>return any errors or warnings in this structure.</p></ol>
 514
 515  </div>
 516 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 517 _8c.html" target="source" name="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
 518 <div class="doc-section">
 519
 520 <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p></ol>
 521
 522 <p>The format of the SetCacheViewStorageClass method is:</p>
 523
 524 <pre class="code">
 525   MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
 526     const ClassType storage_class)
 527 </pre>
 528
 529 <p>A description of each parameter follows:</p></ol>
 530
 531 <h5>cache_view</h5>
 532 <ol><p>the cache view.</p></ol>
 533
 534 <h5>storage_class</h5>
 535 <ol><p>the image storage class: PseudoClass or DirectClass.</p></ol>
 536
 537  </div>
 538 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 539 _8c.html" target="source" name="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
 540 <div class="doc-section">
 541
 542 <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p></ol>
 543
 544 <p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
 545
 546 <pre class="code">
 547   MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
 548     const VirtualPixelMethod virtual_pixel_method)
 549 </pre>
 550
 551 <p>A description of each parameter follows:</p></ol>
 552
 553 <h5>cache_view</h5>
 554 <ol><p>the cache view.</p></ol>
 555
 556 <h5>virtual_pixel_method</h5>
 557 <ol><p>the virtual pixel method.</p></ol>
 558
 559  </div>
 560 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view
 561 _8c.html" target="source" name="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
 562 <div class="doc-section">
 563
 564 <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>
 565
 566 <p>The format of the SyncCacheViewAuthenticPixels method is:</p>
 567
 568 <pre class="code">
 569   MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
 570     ExceptionInfo *exception)
 571 </pre>
 572
 573 <p>A description of each parameter follows:</p></ol>
 574
 575 <h5>cache_view</h5>
 576 <ol><p>the cache view.</p></ol>
 577
 578 <h5>exception</h5>
 579 <ol><p>return any errors or warnings in this structure.</p></ol>
 580
 581  </div>
 582 \r
 583 </div>\r
 584 \r
 585 <div id="linkbar">\r
 586     <span id="linkbar-west">&nbsp;</span>\r
 587     <span id="linkbar-center">\r
 588       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 589     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 590     </span>\r
 591     <span id="linkbar-east">&nbsp;</span>\r
 592   </div>\r
 593   <div class="footer">\r
 594     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 595     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 596   </div>\r
 597   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 598 </body>\r
 599 </html>\r