cache-view.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1" />
  6. <title>ImageMagick – MagickCore, C API: Cache Views</title>
  7. <meta name="application-name" content="ImageMagick" />
  8. <meta name="description" content="" />
  9. <meta name="application-url" content="https://imagemagick.org" />
  10. <meta name="generator" content="PHP" />
  11. <meta name="keywords" content="magickcore, c, api:, cache, views, image processing software" />
  12. <meta name="rating" content="GENERAL" />
  13. <meta name="robots" content="INDEX, FOLLOW" />
  14. <meta name="generator" content="ImageMagick Studio LLC" />
  15. <meta name="author" content="ImageMagick Studio LLC" />
  16. <meta name="revisit-after" content="2 DAYS" />
  17. <meta name="resource-type" content="document" />
  18. <meta name="copyright" content="Copyright (c) 1999 ImageMagick Studio LLC" />
  19. <meta name="distribution" content="Global" />
  20. <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
  21. <meta property='og:url' content='../../' />
  22. <meta property='og:title' content='ImageMagick' />
  23. <meta property='og:image' content='../../../images/logo.png' />
  24. <meta property='og:type' content='website' />
  25. <meta property='og:site_name' content='ImageMagick' />
  26. <meta property='og:description' content="Create, Edit, Compose, or Convert Digital Images" />
  27. <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
  28. <link href="cache-view.html" rel="canonical" />
  29. <link href="../../../images/wand.png" rel="icon" />
  30. <link href="../../../images/wand.ico" rel="shortcut icon" />
  31. <link href="../../assets/magick.css" rel="stylesheet" />
  32. </head>
  33. <body>
  34. <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
  35. <div class="container-fluid">
  36. <a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../images/wand.ico"/></a>
  37. <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation">
  38. <span class="navbar-toggler-icon"></span>
  39. </button>
  40. <div class="collapse navbar-collapse" id="magick-navbars">
  41. <ul class="navbar-nav me-auto mb-2 mb-md-0">
  42. <li class="nav-item">
  43. <a class="nav-link " href="../../www/download.html">Download</a>
  44. </li>
  45. <li class="nav-item">
  46. <a class="nav-link " href="../../www/command-line-tools.html">Tools</a>
  47. </li>
  48. <li class="nav-item">
  49. <a class="nav-link " href="../../www/command-line-processing.html">CLI</a>
  50. </li>
  51. <li class="nav-item">
  52. <a class="nav-link " href="../../www/develop.html">Develop</a>
  53. </li>
  54. <li class="nav-item">
  55. <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
  56. </li>
  57. <li class="nav-item">
  58. <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe>
  59. </li>
  60. </ul>
  61. <form class="d-flex form-inline" action="https://imagemagick.org/script/search.php">
  62. <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search">
  63. <button class="btn btn-outline-success" type="submit" name="sa">Search</button>
  64. </form>
  65. </div>
  66. </div>
  67. </nav>
  68. <div class="container">
  69. <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script>
  70. <ins class="adsbygoogle"
  71. style="display:block"
  72. data-ad-client="ca-pub-3129977114552745"
  73. data-ad-slot="6345125851"
  74. data-full-width-responsive="true"
  75. data-ad-format="horizontal"></ins>
  76. <script>
  77. (adsbygoogle = window.adsbygoogle || []).push({});
  78. </script>
  79. </div>
  80. <main class="container">
  81. <div class="magick-template">
  82. <br/>
  83. <div class="btn-group">
  84. <button class="btn btn-secondary dropdown-toggle" type="button" id="defaultDropdown" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
  85. Select API Method
  86. </button>
  87. <ul class="dropdown-menu pre-scrollable" aria-labelledby="defaultDropdown">
  88. <li><a href="cache-view.html#AcquireAuthenticCacheView">AcquireAuthenticCacheView</a></li>
  89. <li><a href="cache-view.html#AcquireVirtualCacheView">AcquireVirtualCacheView</a></li>
  90. <li><a href="cache-view.html#CloneCacheView">CloneCacheView</a></li>
  91. <li><a href="cache-view.html#DestroyCacheView">DestroyCacheView</a></li>
  92. <li><a href="cache-view.html#GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></li>
  93. <li><a href="cache-view.html#GetCacheViewAuthenticMetacontent">GetCacheViewAuthenticMetacontent</a></li>
  94. <li><a href="cache-view.html#GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></li>
  95. <li><a href="cache-view.html#GetCacheViewColorspace">GetCacheViewColorspace</a></li>
  96. <li><a href="cache-view.html#GetCacheViewImage">GetCacheViewImage</a></li>
  97. <li><a href="cache-view.html#GetCacheViewStorageClass">GetCacheViewStorageClass</a></li>
  98. <li><a href="cache-view.html#GetCacheViewVirtualMetacontent">GetCacheViewVirtualMetacontent</a></li>
  99. <li><a href="cache-view.html#GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></li>
  100. <li><a href="cache-view.html#GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></li>
  101. <li><a href="cache-view.html#GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></li>
  102. <li><a href="cache-view.html#GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></li>
  103. <li><a href="cache-view.html#GetOneCacheViewVirtualPixelInfo">GetOneCacheViewVirtualPixelInfo</a></li>
  104. <li><a href="cache-view.html#GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></li>
  105. <li><a href="cache-view.html#QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></li>
  106. <li><a href="cache-view.html#SetCacheViewStorageClass">SetCacheViewStorageClass</a></li>
  107. <li><a href="cache-view.html#SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></li>
  108. </ul>
  109. </div>
  110. <br/>
  111. <br/>
  112. <div class="magick-header">
  113. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="AcquireAuthenticCacheView">AcquireAuthenticCacheView</a></h2>
  114. <p>AcquireAuthenticCacheView() acquires an authentic view into the pixel cache. It always succeeds but may return a warning or informational exception.</p>
  115. <p>The format of the AcquireAuthenticCacheView method is:</p>
  116. <pre class="bg-light text-dark mx-4"><samp>CacheView *AcquireAuthenticCacheView(const Image *image,
  117. ExceptionInfo *exception)
  118. </samp></pre>
  119. <p>A description of each parameter follows:</p>
  120. <dd>
  121. </dd>
  122. <dd> </dd>
  123. <dl class="dl-horizontal">
  124. <dt>image</dt>
  125. <dd>the image. </dd>
  126. <dd> </dd>
  127. <dt>exception</dt>
  128. <dd>return any errors or warnings in this structure. </dd>
  129. <dd> </dd>
  130. </dl>
  131. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="AcquireVirtualCacheView">AcquireVirtualCacheView</a></h2>
  132. <p>AcquireVirtualCacheView() acquires a virtual view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself. It always succeeds but may return a warning or informational exception.</p>
  133. <p>The format of the AcquireVirtualCacheView method is:</p>
  134. <pre class="bg-light text-dark mx-4"><samp>CacheView *AcquireVirtualCacheView(const Image *image,
  135. ExceptionInfo *exception)
  136. </samp></pre>
  137. <p>A description of each parameter follows:</p>
  138. <dd>
  139. </dd>
  140. <dd> </dd>
  141. <dl class="dl-horizontal">
  142. <dt>image</dt>
  143. <dd>the image. </dd>
  144. <dd> </dd>
  145. <dt>exception</dt>
  146. <dd>return any errors or warnings in this structure. </dd>
  147. <dd> </dd>
  148. </dl>
  149. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="CloneCacheView">CloneCacheView</a></h2>
  150. <p>CloneCacheView() makes an exact copy of the specified cache view.</p>
  151. <p>The format of the CloneCacheView method is:</p>
  152. <pre class="bg-light text-dark mx-4"><samp>CacheView *CloneCacheView(const CacheView *cache_view)
  153. </samp></pre>
  154. <p>A description of each parameter follows:</p>
  155. <dd>
  156. </dd>
  157. <dd> </dd>
  158. <dl class="dl-horizontal">
  159. <dt>cache_view</dt>
  160. <dd>the cache view. </dd>
  161. <dd> </dd>
  162. </dl>
  163. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="DestroyCacheView">DestroyCacheView</a></h2>
  164. <p>DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().</p>
  165. <p>The format of the DestroyCacheView method is:</p>
  166. <pre class="bg-light text-dark mx-4"><samp>CacheView *DestroyCacheView(CacheView *cache_view)
  167. </samp></pre>
  168. <p>A description of each parameter follows:</p>
  169. <dd>
  170. </dd>
  171. <dd> </dd>
  172. <dl class="dl-horizontal">
  173. <dt>cache_view</dt>
  174. <dd>the cache view. </dd>
  175. <dd> </dd>
  176. </dl>
  177. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixels">GetCacheViewAuthenticPixels</a></h2>
  178. <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>
  179. <p>The format of the GetCacheViewAuthenticPixels method is:</p>
  180. <pre class="bg-light text-dark mx-4"><samp>Quantum *GetCacheViewAuthenticPixels(CacheView *cache_view,
  181. const ssize_t x,const ssize_t y,const size_t columns,
  182. const size_t rows,ExceptionInfo *exception)
  183. </samp></pre>
  184. <p>A description of each parameter follows:</p>
  185. <dd>
  186. </dd>
  187. <dd> </dd>
  188. <dl class="dl-horizontal">
  189. <dt>cache_view</dt>
  190. <dd>the cache view. </dd>
  191. <dd> </dd>
  192. <dt>x,y,columns,rows</dt>
  193. <dd> These values define the perimeter of a region of pixels. </dd>
  194. <dd> </dd>
  195. <dt>exception</dt>
  196. <dd>return any errors or warnings in this structure. </dd>
  197. <dd> </dd>
  198. </dl>
  199. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticMetacontent">GetCacheViewAuthenticMetacontent</a></h2>
  200. <p>GetCacheViewAuthenticMetacontent() returns the meta-content corresponding with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticMetacontent(). The meta-content are authentic and can be updated.</p>
  201. <p>The format of the GetCacheViewAuthenticMetacontent() method is:</p>
  202. <pre class="bg-light text-dark mx-4"><samp>void *GetCacheViewAuthenticMetacontent(CacheView *cache_view)
  203. </samp></pre>
  204. <p>A description of each parameter follows:</p>
  205. <dd>
  206. </dd>
  207. <dd> </dd>
  208. <dl class="dl-horizontal">
  209. <dt>cache_view</dt>
  210. <dd>the cache view. </dd>
  211. <dd> </dd>
  212. </dl>
  213. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewAuthenticPixelQueue">GetCacheViewAuthenticPixelQueue</a></h2>
  214. <p>GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be updated.</p>
  215. <p>The format of the GetCacheViewAuthenticPixelQueue() method is:</p>
  216. <pre class="bg-light text-dark mx-4"><samp>Quantum *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
  217. </samp></pre>
  218. <p>A description of each parameter follows:</p>
  219. <dd>
  220. </dd>
  221. <dd> </dd>
  222. <dl class="dl-horizontal">
  223. <dt>cache_view</dt>
  224. <dd>the cache view. </dd>
  225. <dd> </dd>
  226. </dl>
  227. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewColorspace">GetCacheViewColorspace</a></h2>
  228. <p>GetCacheViewColorspace() returns the image colorspace associated with the specified view.</p>
  229. <p>The format of the GetCacheViewColorspace method is:</p>
  230. <pre class="bg-light text-dark mx-4"><samp>ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
  231. </samp></pre>
  232. <p>A description of each parameter follows:</p>
  233. <dd>
  234. </dd>
  235. <dd> </dd>
  236. <dl class="dl-horizontal">
  237. <dt>cache_view</dt>
  238. <dd>the cache view. </dd>
  239. <dd> </dd>
  240. </dl>
  241. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewImage">GetCacheViewImage</a></h2>
  242. <p>GetCacheViewImage() returns the image associated with the specified view.</p>
  243. <p>The format of the GetCacheViewImage method is:</p>
  244. <pre class="bg-light text-dark mx-4"><samp>const Image *GetCacheViewImage(const CacheView *cache_view)
  245. </samp></pre>
  246. <p>A description of each parameter follows:</p>
  247. <dd>
  248. </dd>
  249. <dd> </dd>
  250. <dl class="dl-horizontal">
  251. <dt>cache_view</dt>
  252. <dd>the cache view. </dd>
  253. <dd> </dd>
  254. </dl>
  255. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewStorageClass">GetCacheViewStorageClass</a></h2>
  256. <p>GetCacheViewStorageClass() returns the image storage class associated with the specified view.</p>
  257. <p>The format of the GetCacheViewStorageClass method is:</p>
  258. <pre class="bg-light text-dark mx-4"><samp>ClassType GetCacheViewStorageClass(const CacheView *cache_view)
  259. </samp></pre>
  260. <p>A description of each parameter follows:</p>
  261. <dd>
  262. </dd>
  263. <dd> </dd>
  264. <dl class="dl-horizontal">
  265. <dt>cache_view</dt>
  266. <dd>the cache view. </dd>
  267. <dd> </dd>
  268. </dl>
  269. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualMetacontent">GetCacheViewVirtualMetacontent</a></h2>
  270. <p>GetCacheViewVirtualMetacontent() returns the meta-content corresponding with the last call to GetCacheViewVirtualMetacontent(). The meta-content is virtual and therefore cannot be updated.</p>
  271. <p>The format of the GetCacheViewVirtualMetacontent() method is:</p>
  272. <pre class="bg-light text-dark mx-4"><samp>const void *GetCacheViewVirtualMetacontent(
  273. const CacheView *cache_view)
  274. </samp></pre>
  275. <p>A description of each parameter follows:</p>
  276. <dd>
  277. </dd>
  278. <dd> </dd>
  279. <dl class="dl-horizontal">
  280. <dt>cache_view</dt>
  281. <dd>the cache view. </dd>
  282. <dd> </dd>
  283. </dl>
  284. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixelQueue">GetCacheViewVirtualPixelQueue</a></h2>
  285. <p>GetCacheViewVirtualPixelQueue() returns the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.</p>
  286. <p>The format of the GetCacheViewVirtualPixelQueue() method is:</p>
  287. <pre class="bg-light text-dark mx-4"><samp>const Quantum *GetCacheViewVirtualPixelQueue(
  288. const CacheView *cache_view)
  289. </samp></pre>
  290. <p>A description of each parameter follows:</p>
  291. <dd>
  292. </dd>
  293. <dd> </dd>
  294. <dl class="dl-horizontal">
  295. <dt>cache_view</dt>
  296. <dd>the cache view. </dd>
  297. <dd> </dd>
  298. </dl>
  299. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetCacheViewVirtualPixels">GetCacheViewVirtualPixels</a></h2>
  300. <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>
  301. <p>The format of the GetCacheViewVirtualPixels method is:</p>
  302. <pre class="bg-light text-dark mx-4"><samp>const Quantum *GetCacheViewVirtualPixels(
  303. const CacheView *cache_view,const ssize_t x,const ssize_t y,
  304. const size_t columns,const size_t rows,ExceptionInfo *exception)
  305. </samp></pre>
  306. <p>A description of each parameter follows:</p>
  307. <dd>
  308. </dd>
  309. <dd> </dd>
  310. <dl class="dl-horizontal">
  311. <dt>cache_view</dt>
  312. <dd>the cache view. </dd>
  313. <dd> </dd>
  314. <dt>x,y,columns,rows</dt>
  315. <dd> These values define the perimeter of a region of pixels. </dd>
  316. <dd> </dd>
  317. <dt>exception</dt>
  318. <dd>return any errors or warnings in this structure. </dd>
  319. <dd> </dd>
  320. </dl>
  321. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetOneCacheViewAuthenticPixel">GetOneCacheViewAuthenticPixel</a></h2>
  322. <p>GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.</p>
  323. <p>The format of the GetOneCacheViewAuthenticPixel method is:</p>
  324. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType GetOneCacheViewAuthenticPixel(
  325. const CacheView *cache_view,const ssize_t x,const ssize_t y,
  326. Quantum *pixel,ExceptionInfo *exception)
  327. </samp></pre>
  328. <p>A description of each parameter follows:</p>
  329. <dd>
  330. </dd>
  331. <dd> </dd>
  332. <dl class="dl-horizontal">
  333. <dt>cache_view</dt>
  334. <dd>the cache view. </dd>
  335. <dd> </dd>
  336. <dt>x,y</dt>
  337. <dd> These values define the offset of the pixel. </dd>
  338. <dd> </dd>
  339. <dt>pixel</dt>
  340. <dd>return a pixel at the specified (x,y) location. </dd>
  341. <dd> </dd>
  342. <dt>exception</dt>
  343. <dd>return any errors or warnings in this structure. </dd>
  344. <dd> </dd>
  345. </dl>
  346. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixel">GetOneCacheViewVirtualPixel</a></h2>
  347. <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>
  348. <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
  349. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType GetOneCacheViewVirtualPixel(
  350. const CacheView *cache_view,const ssize_t x,const ssize_t y,
  351. Quantum *pixel,ExceptionInfo *exception)
  352. </samp></pre>
  353. <p>A description of each parameter follows:</p>
  354. <dd>
  355. </dd>
  356. <dd> </dd>
  357. <dl class="dl-horizontal">
  358. <dt>cache_view</dt>
  359. <dd>the cache view. </dd>
  360. <dd> </dd>
  361. <dt>x,y</dt>
  362. <dd> These values define the offset of the pixel. </dd>
  363. <dd> </dd>
  364. <dt>pixel</dt>
  365. <dd>return a pixel at the specified (x,y) location. </dd>
  366. <dd> </dd>
  367. <dt>exception</dt>
  368. <dd>return any errors or warnings in this structure. </dd>
  369. <dd> </dd>
  370. </dl>
  371. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualPixelInfo">GetOneCacheViewVirtualPixelInfo</a></h2>
  372. <p>GetOneCacheViewVirtualPixelInfo() 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>
  373. <p>The format of the GetOneCacheViewVirtualPixelInfo method is:</p>
  374. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType GetOneCacheViewVirtualPixelInfo(
  375. const CacheView *cache_view,const ssize_t x,const ssize_t y,
  376. PixelInfo *pixel,ExceptionInfo *exception)
  377. </samp></pre>
  378. <p>A description of each parameter follows:</p>
  379. <dd>
  380. </dd>
  381. <dd> </dd>
  382. <dl class="dl-horizontal">
  383. <dt>cache_view</dt>
  384. <dd>the cache view. </dd>
  385. <dd> </dd>
  386. <dt>x,y</dt>
  387. <dd> These values define the offset of the pixel. </dd>
  388. <dd> </dd>
  389. <dt>pixel</dt>
  390. <dd>return a pixel at the specified (x,y) location. </dd>
  391. <dd> </dd>
  392. <dt>exception</dt>
  393. <dd>return any errors or warnings in this structure. </dd>
  394. <dd> </dd>
  395. </dl>
  396. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="GetOneCacheViewVirtualMethodPixel">GetOneCacheViewVirtualMethodPixel</a></h2>
  397. <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>
  398. <p>The format of the GetOneCacheViewVirtualPixel method is:</p>
  399. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType GetOneCacheViewVirtualMethodPixel(
  400. const CacheView *cache_view,
  401. const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
  402. const ssize_t y,Quantum *pixel,ExceptionInfo *exception)
  403. </samp></pre>
  404. <p>A description of each parameter follows:</p>
  405. <dd>
  406. </dd>
  407. <dd> </dd>
  408. <dl class="dl-horizontal">
  409. <dt>cache_view</dt>
  410. <dd>the cache view. </dd>
  411. <dd> </dd>
  412. <dt>virtual_pixel_method</dt>
  413. <dd>the virtual pixel method. </dd>
  414. <dd> </dd>
  415. <dt>x,y</dt>
  416. <dd> These values define the offset of the pixel. </dd>
  417. <dd> </dd>
  418. <dt>pixel</dt>
  419. <dd>return a pixel at the specified (x,y) location. </dd>
  420. <dd> </dd>
  421. <dt>exception</dt>
  422. <dd>return any errors or warnings in this structure. </dd>
  423. <dd> </dd>
  424. </dl>
  425. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="QueueCacheViewAuthenticPixels">QueueCacheViewAuthenticPixels</a></h2>
  426. <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>
  427. <p>The format of the QueueCacheViewAuthenticPixels method is:</p>
  428. <pre class="bg-light text-dark mx-4"><samp>Quantum *QueueCacheViewAuthenticPixels(CacheView *cache_view,
  429. const ssize_t x,const ssize_t y,const size_t columns,
  430. const size_t rows,ExceptionInfo *exception)
  431. </samp></pre>
  432. <p>A description of each parameter follows:</p>
  433. <dd>
  434. </dd>
  435. <dd> </dd>
  436. <dl class="dl-horizontal">
  437. <dt>cache_view</dt>
  438. <dd>the cache view. </dd>
  439. <dd> </dd>
  440. <dt>x,y,columns,rows</dt>
  441. <dd> These values define the perimeter of a region of pixels. </dd>
  442. <dd> </dd>
  443. <dt>exception</dt>
  444. <dd>return any errors or warnings in this structure. </dd>
  445. <dd> </dd>
  446. </dl>
  447. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="SetCacheViewStorageClass">SetCacheViewStorageClass</a></h2>
  448. <p>SetCacheViewStorageClass() sets the image storage class associated with the specified view.</p>
  449. <p>The format of the SetCacheViewStorageClass method is:</p>
  450. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
  451. const ClassType storage_class,ExceptionInfo *exception)
  452. </samp></pre>
  453. <p>A description of each parameter follows:</p>
  454. <dd>
  455. </dd>
  456. <dd> </dd>
  457. <dl class="dl-horizontal">
  458. <dt>cache_view</dt>
  459. <dd>the cache view. </dd>
  460. <dd> </dd>
  461. <dt>storage_class</dt>
  462. <dd>the image storage class: PseudoClass or DirectClass. </dd>
  463. <dd> </dd>
  464. <dt>exception</dt>
  465. <dd>return any errors or warnings in this structure. </dd>
  466. <dd> </dd>
  467. </dl>
  468. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="SetCacheViewVirtualPixelMethod">SetCacheViewVirtualPixelMethod</a></h2>
  469. <p>SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.</p>
  470. <p>The format of the SetCacheViewVirtualPixelMethod method is:</p>
  471. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
  472. const VirtualPixelMethod virtual_pixel_method)
  473. </samp></pre>
  474. <p>A description of each parameter follows:</p>
  475. <dd>
  476. </dd>
  477. <dd> </dd>
  478. <dl class="dl-horizontal">
  479. <dt>cache_view</dt>
  480. <dd>the cache view. </dd>
  481. <dd> </dd>
  482. <dt>virtual_pixel_method</dt>
  483. <dd>the virtual pixel method. </dd>
  484. <dd> </dd>
  485. </dl>
  486. <h2><a href="../../api/MagickCore/cache-view_8c.html" id="SyncCacheViewAuthenticPixels">SyncCacheViewAuthenticPixels</a></h2>
  487. <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>
  488. <p>The format of the SyncCacheViewAuthenticPixels method is:</p>
  489. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
  490. ExceptionInfo *exception)
  491. </samp></pre>
  492. <p>A description of each parameter follows:</p>
  493. <dd>
  494. </dd>
  495. <dd> </dd>
  496. <dl class="dl-horizontal">
  497. <dt>cache_view</dt>
  498. <dd>the cache view. </dd>
  499. <dd> </dd>
  500. <dt>exception</dt>
  501. <dd>return any errors or warnings in this structure. </dd>
  502. <dd> </dd>
  503. </dl>
  504. </div>
  505. </div>
  506. </main><!-- /.container -->
  507. <footer class="magick-footer">
  508. <div class="container-fluid">
  509. <a href="../../www/security-policy.html">Security</a> •
  510. <a href="../../www/news.html">News</a>
  511. <a href="cache-view.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../images/wand.ico"/></a>
  512. <a href="../../www/links.html">Related</a> •
  513. <a href="../../www/sitemap.html">Sitemap</a>
  514. <br/>
  515. <a href="../../www/support.html">Sponsor</a> •
  516. <a href="../../www/cite.html">Cite</a> •
  517. <a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
  518. <a href="../../www/contact.html">Contact Us</a>
  519. <br/>
  520. <a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> •
  521. <a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 300 300" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path d="M178.57 127.15 290.27 0h-26.46l-97.03 110.38L89.34 0H0l117.13 166.93L0 300.25h26.46l102.4-116.59 81.8 116.59h89.34M36.01 19.54H76.66l187.13 262.13h-40.66"/></svg></a>
  522. <br/>
  523. <small>Copyright © 1999 ImageMagick Studio LLC</small>
  524. </div>
  525. </footer>
  526. <!-- Javascript assets -->
  527. <script src="../../assets/magick.js" ></script>
  528. </body>
  529. </html>