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 automagically."/>
  17   <meta name="Application-url" content="http://www.imagemagick.org"/>
  18   <meta name="Generator" content="PHP"/>
  19   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, cache, views, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Image, Processing, Automagically"/>
  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 <div style="margin: 17px auto; float: left;">\r
  53   <script type="text/javascript">\r
  54   <!--\r
  55     google_ad_client = "pub-3129977114552745";\r
  56     google_ad_slot = "5439289906";\r
  57     google_ad_width = 728;\r
  58     google_ad_height = 90;\r
  59   //-->\r
  60   </script>\r
  61   <script type="text/javascript"\r
  62     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
  63   </script>\r
  64 </div>\r
  65 <a href="http://www.imagemagick.org/discourse-server/">\r
  66   <img src="../../images/logo.jpg"\r
  67   alt="ImageMagick Logo"\r
  68   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  69 <a href="../../index.html">\r
  70   <img src="../../images/sprite.jpg"\r
  71   alt="ImageMagick Sprite"\r
  72   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  73 </div>\r
  74 \r
  75 <div class="westbar">\r
  76 \r
  77 <div class="menu">
  78   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div class="menu">
  82   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  83 </div>
  84 <div class="sub">
  85     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  89 </div>
  90 <div class="sub">
  91     <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
  92 </div>
  93 <div class="sub">
  94     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  95 </div>
  96 <div class="sep"></div>\r
  97 <div class="menu">
  98   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
 105 </div>
 106 <div class="sub">
 107     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 108 </div>
 109 <div class="menu">
 110   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 111 </div>
 112 <div class="sub">
 113     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 114 </div>
 115 <div class="sub">
 116     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 117 </div>
 118 <div class="sub">
 119     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 120 </div>
 121 <div class="sub">
 122     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 133  </div>
 134 <div class="menu">
 135   <a title="Resources" href="../../www/resources.html">Resources</a>
 136 </div>
 137 <div class="menu">
 138   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 139 </div>
 140 <div class="menu">
 141   <a title="Download" href="../../www/download.html">Download</a>
 142 </div>
 143 <div class="sep"></div>\r
 144 <div class="menu">
 145   <a title="Search" href="../../www/search.html">Search</a>
 146 </div>
 147 <div class="sep"></div>\r
 148 <div class="menu">
 149   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 150 </div>
 151 <div  class="sub">
 152   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 153 </div>
 154 <div class="sep"></div>\r
 155 <div  class="menu">
 156   <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 157
 158 <a href="http://www.networkredux.com">
 159   <img src="../../images/networkredux.png" alt="[sponsor]"
 160   style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 161 <div class="sponsbox">
 162 <div  class="sponsor">
 163   <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
 164 </div>
 165 <div  class="sponsor">
 166   <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
 167 </div>
 168 <div  class="sponsor">
 169   <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 170 </div>
 171 <div  class="sponsor">
 172   <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
 173 </div>
 174 <div  class="sponsor">
 175   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
 176 </div>
 177 <div  class="sponsor">
 178   <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
 179 </div>
 180 <div  class="sponsor">
 181   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 182 </div>
 183 <div  class="sponsor">
 184   <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
 185 </div>
 186 <div  class="sponsor">
 187   <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 188 </div>
 189 <div  class="sponsor">
 190   <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 191 </div>
 192 <div  class="sponsor">
 193   <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 194 </div>
 195 <div  class="sponsor">
 196   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
 197 </div>
 198 <div  class="sponsor">
 199   <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 200 </div>
 201 <div  class="sponsor">
 202    <a rel="follow" title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
 203 </div>
 204 </div>
 205 </div>
 206 </div>\r
 207 \r
 208 <div class="eastbar">\r
 209 \r
 210 </div>\r
 211 \r
 212 <div class="main">\r
 213 \r
 214 <h1>Module cache-view Methods</h1>
 215 <p class="navigation-index">[<a href="#AcquireCacheView">AcquireCacheView</a> &bull; <a href="#CloneCacheView">CloneCacheView</a> &bull; <a href="#DestroyCacheView">DestroyCacheView</a> &bull; <a href="#GetCacheViewChannels">GetCacheViewChannels</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>
 216
 217 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="AcquireCacheView">AcquireCacheView</a></h2>
 218 <div class="doc-section">
 219
 220 <p>AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.</p>
 221
 222 <p>The format of the AcquireCacheView method is:</p>
 223
 224 <pre class="code">
 225   CacheView *AcquireCacheView(const Image *image)
 226 </pre>
 227
 228 <p>A description of each parameter follows:</p>
 229
 230 <h5>image</h5>
 231 <p>the image.</p>
 232
 233  </div>
 234 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="CloneCacheView">CloneCacheView</a></h2>
 235 <div class="doc-section">
 236
 237 <p>CloneCacheView()  makes an exact copy of the specified cache view.</p>
 238
 239 <p>The format of the CloneCacheView method is:</p>
 240
 241 <pre class="code">
 242   CacheView *CloneCacheView(const CacheView *cache_view)
 243 </pre>
 244
 245 <p>A description of each parameter follows:</p>
 246
 247 <h5>cache_view</h5>
 248 <p>the cache view.</p>
 249
 250  </div>
 251 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="DestroyCacheView">DestroyCacheView</a></h2>
 252 <div class="doc-section">
 253
 254 <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p>
 255
 256 <p>The format of the DestroyCacheView method is:</p>
 257
 258 <pre class="code">
 259   CacheView *DestroyCacheView(CacheView *cache_view)
 260 </pre>
 261
 262 <p>A description of each parameter follows:</p>
 263
 264 <h5>cache_view</h5>
 265 <p>the cache view.</p>
 266
 267  </div>
 268 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewChannels">GetCacheViewChannels</a></h2>
 269 <div class="doc-section">
 270
 271 <p>GetCacheViewChannels() returns the image pixel channels associated with the specified view.</p>
 272
 273 <p>The format of the GetCacheViewChannels method is:</p>
 274
 275 <pre class="code">
 276   size_t GetCacheViewChannels(const CacheView *cache_view)
 277 </pre>
 278
 279 <p>A description of each parameter follows:</p>
 280
 281 <h5>cache_view</h5>
 282 <p>the cache view.</p>
 283
 284  </div>
 285 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
 286 <div class="doc-section">
 287
 288 <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p>
 289
 290 <p>The format of the GetCacheViewColorspace method is:</p>
 291
 292 <pre class="code">
 293   ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
 294 </pre>
 295
 296 <p>A description of each parameter follows:</p>
 297
 298 <h5>cache_view</h5>
 299 <p>the cache view.</p>
 300
 301  </div>
 302 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewException">GetCacheViewException</a></h2>
 303 <div class="doc-section">
 304
 305 <p>GetCacheViewException() returns the image exception associated with the specified view.</p>
 306
 307 <p>The format of the GetCacheViewException method is:</p>
 308
 309 <pre class="code">
 310   ExceptionInfo GetCacheViewException(const CacheView *cache_view)
 311 </pre>
 312
 313 <p>A description of each parameter follows:</p>
 314
 315 <h5>cache_view</h5>
 316 <p>the cache view.</p>
 317
 318  </div>
 319 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
 320 <div class="doc-section">
 321
 322 <p>GetCacheViewStorageClass() returns the image storage class  associated with the specified view.</p>
 323
 324 <p>The format of the GetCacheViewStorageClass method is:</p>
 325
 326 <pre class="code">
 327   ClassType GetCacheViewStorageClass(const CacheView *cache_view)
 328 </pre>
 329
 330 <p>A description of each parameter follows:</p>
 331
 332 <h5>cache_view</h5>
 333 <p>the cache view.</p>
 334
 335  </div>
 336 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
 337 <div class="doc-section">
 338
 339 <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>
 340
 341 <p>The format of the GetCacheViewAuthenticPixels method is:</p>
 342
 343 <pre class="code">
 344   PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
 345     const ssize_t x,const ssize_t y,const size_t columns,
 346     const size_t rows,ExceptionInfo *exception)
 347 </pre>
 348
 349 <p>A description of each parameter follows:</p>
 350
 351 <h5>cache_view</h5>
 352 <p>the cache view.</p>
 353
 354 <h5>x,y,columns,rows</h5>
 355 <p>These values define the perimeter of a region of pixels.</p>
 356
 357  </div>
 358 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
 359 <div class="doc-section">
 360
 361 <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location.  The image background color is returned if an error occurs.</p>
 362
 363 <p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
 364
 365 <pre class="code">
 366   MagickBooleaNType GetOneCacheViewAuthenticPixel(
 367     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 368     Pixelpacket *pixel,ExceptionInfo *exception)
 369 </pre>
 370
 371 <p>A description of each parameter follows:</p>
 372
 373 <h5>cache_view</h5>
 374 <p>the cache view.</p>
 375
 376 <h5>x,y</h5>
 377 <p>These values define the offset of the pixel.</p>
 378
 379 <h5>pixel</h5>
 380 <p>return a pixel at the specified (x,y) location.</p>
 381
 382 <h5>exception</h5>
 383 <p>return any errors or warnings in this structure.</p>
 384
 385  </div>
 386 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticIndexQueue">GetCacheViewAuthenticIndexQueue</a></h2>
 387 <div class="doc-section">
 388
 389 <p>GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue().  The indexes are authentic and can be updated.</p>
 390
 391 <p>The format of the GetCacheViewAuthenticIndexQueue() method is:</p>
 392
 393 <pre class="code">
 394   IndexPacket *GetCacheViewAuthenticIndexQueue(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="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
 404 <div class="doc-section">
 405
 406 <p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels().  The pixels are authentic and therefore can be updated.</p>
 407
 408 <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
 409
 410 <pre class="code">
 411   PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
 412 </pre>
 413
 414 <p>A description of each parameter follows:</p>
 415
 416 <h5>cache_view</h5>
 417 <p>the cache view.</p>
 418
 419  </div>
 420 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualIndexQueue">GetCacheViewVirtualIndexQueue</a></h2>
 421 <div class="doc-section">
 422
 423 <p>GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue().  The indexes are virtual and therefore cannot be updated.</p>
 424
 425 <p>The format of the GetCacheViewVirtualIndexQueue() method is:</p>
 426
 427 <pre class="code">
 428   const IndexPacket *GetCacheViewVirtualIndexQueue(
 429     const CacheView *cache_view)
 430 </pre>
 431
 432 <p>A description of each parameter follows:</p>
 433
 434 <h5>cache_view</h5>
 435 <p>the cache view.</p>
 436
 437  </div>
 438 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
 439 <div class="doc-section">
 440
 441 <p>GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels().  The pixels are virtual and therefore cannot be updated.</p>
 442
 443 <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
 444
 445 <pre class="code">
 446   const PixelPacket *GetCacheViewVirtualPixelQueue(
 447     const CacheView *cache_view)
 448 </pre>
 449
 450 <p>A description of each parameter follows:</p>
 451
 452 <h5>cache_view</h5>
 453 <p>the cache view.</p>
 454
 455  </div>
 456 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
 457 <div class="doc-section">
 458
 459 <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>
 460
 461 <p>The format of the GetCacheViewVirtualPixels method is:</p>
 462
 463 <pre class="code">
 464   const PixelPacket *GetCacheViewVirtualPixels(
 465     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 466     const size_t columns,const size_t rows,ExceptionInfo *exception)
 467 </pre>
 468
 469 <p>A description of each parameter follows:</p>
 470
 471 <h5>cache_view</h5>
 472 <p>the cache view.</p>
 473
 474 <h5>x,y,columns,rows</h5>
 475 <p>These values define the perimeter of a region of pixels.</p>
 476
 477 <h5>exception</h5>
 478 <p>return any errors or warnings in this structure.</p>
 479
 480  </div>
 481 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
 482 <div class="doc-section">
 483
 484 <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>
 485
 486 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 487
 488 <pre class="code">
 489   MagickBooleanType GetOneCacheViewVirtualPixel(
 490     const CacheView *cache_view,const ssize_t x,const ssize_t y,
 491     PixelPacket *pixel,ExceptionInfo *exception)
 492 </pre>
 493
 494 <p>A description of each parameter follows:</p>
 495
 496 <h5>cache_view</h5>
 497 <p>the cache view.</p>
 498
 499 <h5>x,y</h5>
 500 <p>These values define the offset of the pixel.</p>
 501
 502 <h5>pixel</h5>
 503 <p>return a pixel at the specified (x,y) location.</p>
 504
 505 <h5>exception</h5>
 506 <p>return any errors or warnings in this structure.</p>
 507
 508  </div>
 509 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
 510 <div class="doc-section">
 511
 512 <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>
 513
 514 <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
 515
 516 <pre class="code">
 517   MagickBooleanType GetOneCacheViewVirtualMethodPixel(
 518     const CacheView *cache_view,
 519     const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
 520     const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
 521 </pre>
 522
 523 <p>A description of each parameter follows:</p>
 524
 525 <h5>cache_view</h5>
 526 <p>the cache view.</p>
 527
 528 <h5>virtual_pixel_method</h5>
 529 <p>the virtual pixel method.</p>
 530
 531 <h5>x,y</h5>
 532 <p>These values define the offset of the pixel.</p>
 533
 534 <h5>pixel</h5>
 535 <p>return a pixel at the specified (x,y) location.</p>
 536
 537 <h5>exception</h5>
 538 <p>return any errors or warnings in this structure.</p>
 539
 540  </div>
 541 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
 542 <div class="doc-section">
 543
 544 <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>
 545
 546 <p>The format of the QueueCacheViewAuthenticPixels method is:</p>
 547
 548 <pre class="code">
 549   PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
 550     const ssize_t x,const ssize_t y,const size_t columns,
 551     const size_t rows,ExceptionInfo *exception)
 552 </pre>
 553
 554 <p>A description of each parameter follows:</p>
 555
 556 <h5>cache_view</h5>
 557 <p>the cache view.</p>
 558
 559 <h5>x,y,columns,rows</h5>
 560 <p>These values define the perimeter of a region of pixels.</p>
 561
 562 <h5>exception</h5>
 563 <p>return any errors or warnings in this structure.</p>
 564
 565  </div>
 566 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
 567 <div class="doc-section">
 568
 569 <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p>
 570
 571 <p>The format of the SetCacheViewStorageClass method is:</p>
 572
 573 <pre class="code">
 574   MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
 575     const ClassType storage_class)
 576 </pre>
 577
 578 <p>A description of each parameter follows:</p>
 579
 580 <h5>cache_view</h5>
 581 <p>the cache view.</p>
 582
 583 <h5>storage_class</h5>
 584 <p>the image storage class: PseudoClass or DirectClass.</p>
 585
 586  </div>
 587 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
 588 <div class="doc-section">
 589
 590 <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p>
 591
 592 <p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
 593
 594 <pre class="code">
 595   MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
 596     const VirtualPixelMethod virtual_pixel_method)
 597 </pre>
 598
 599 <p>A description of each parameter follows:</p>
 600
 601 <h5>cache_view</h5>
 602 <p>the cache view.</p>
 603
 604 <h5>virtual_pixel_method</h5>
 605 <p>the virtual pixel method.</p>
 606
 607  </div>
 608 <h2><a href="http://www.imagemagick.org/api/MagickCore/cache-view_8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
 609 <div class="doc-section">
 610
 611 <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>
 612
 613 <p>The format of the SyncCacheViewAuthenticPixels method is:</p>
 614
 615 <pre class="code">
 616   MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
 617     ExceptionInfo *exception)
 618 </pre>
 619
 620 <p>A description of each parameter follows:</p>
 621
 622 <h5>cache_view</h5>
 623 <p>the cache view.</p>
 624
 625 <h5>exception</h5>
 626 <p>return any errors or warnings in this structure.</p>
 627
 628  </div>
 629 \r
 630 </div>\r
 631 \r
 632 <div id="linkbar">\r
 633     <span id="linkbar-west">&nbsp;</span>\r
 634     <span id="linkbar-center">\r
 635       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 636       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 637     </span>\r
 638     <span id="linkbar-east">&nbsp;</span>\r
 639   </div>\r
 640   <div class="footer">\r
 641     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 642     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 643   </div>\r
 644   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 645   <script type="text/javascript">\r
 646     var _gaq = _gaq || [];\r
 647     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 648     _gaq.push(['_trackPageview']);\r
 649 \r
 650     (function() {\r
 651       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 652       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 653       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 654     })();\r
 655   </script>\r
 656 </body>\r
 657 </html>\r