/usr/share/doc/libjuce/apiref/classImageCache.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: ImageCache Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classImageCache-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ImageCache Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A global cache of images that have been loaded from files or memory.
<a href="classImageCache.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:acc266a65cf61dd0a2f68e68840b4a5c4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classImage.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageCache.html#acc266a65cf61dd0a2f68e68840b4a5c4">getFromFile</a> (const <a class="el" href="classFile.html">File</a> &file)</td></tr>
<tr class="memdesc:acc266a65cf61dd0a2f68e68840b4a5c4"><td class="mdescLeft"> </td><td class="mdescRight">Loads an image from a file, (or just returns the image if it's already cached). <a href="#acc266a65cf61dd0a2f68e68840b4a5c4">More...</a><br /></td></tr>
<tr class="separator:acc266a65cf61dd0a2f68e68840b4a5c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3e80d35b973c3cb47a031185ff56c06"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classImage.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageCache.html#ac3e80d35b973c3cb47a031185ff56c06">getFromMemory</a> (const void *imageData, int dataSize)</td></tr>
<tr class="memdesc:ac3e80d35b973c3cb47a031185ff56c06"><td class="mdescLeft"> </td><td class="mdescRight">Loads an image from an in-memory image file, (or just returns the image if it's already cached). <a href="#ac3e80d35b973c3cb47a031185ff56c06">More...</a><br /></td></tr>
<tr class="separator:ac3e80d35b973c3cb47a031185ff56c06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ebcfbc2287268f4312c8137a913bca4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classImage.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageCache.html#a4ebcfbc2287268f4312c8137a913bca4">getFromHashCode</a> (<a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> hashCode)</td></tr>
<tr class="memdesc:a4ebcfbc2287268f4312c8137a913bca4"><td class="mdescLeft"> </td><td class="mdescRight">Checks the cache for an image with a particular hashcode. <a href="#a4ebcfbc2287268f4312c8137a913bca4">More...</a><br /></td></tr>
<tr class="separator:a4ebcfbc2287268f4312c8137a913bca4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba7b8b9196a99296dc3900fb6d01f04a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageCache.html#aba7b8b9196a99296dc3900fb6d01f04a">addImageToCache</a> (const <a class="el" href="classImage.html">Image</a> &image, <a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> hashCode)</td></tr>
<tr class="memdesc:aba7b8b9196a99296dc3900fb6d01f04a"><td class="mdescLeft"> </td><td class="mdescRight">Adds an image to the cache with a user-defined hash-code. <a href="#aba7b8b9196a99296dc3900fb6d01f04a">More...</a><br /></td></tr>
<tr class="separator:aba7b8b9196a99296dc3900fb6d01f04a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e8f2a2260acf7ca4f4a62c36ce99332"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageCache.html#a7e8f2a2260acf7ca4f4a62c36ce99332">setCacheTimeout</a> (int millisecs)</td></tr>
<tr class="memdesc:a7e8f2a2260acf7ca4f4a62c36ce99332"><td class="mdescLeft"> </td><td class="mdescRight">Changes the amount of time before an unused image will be removed from the cache. <a href="#a7e8f2a2260acf7ca4f4a62c36ce99332">More...</a><br /></td></tr>
<tr class="separator:a7e8f2a2260acf7ca4f4a62c36ce99332"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59842f582bd240a820fb5e44b956b121"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageCache.html#a59842f582bd240a820fb5e44b956b121">releaseUnusedImages</a> ()</td></tr>
<tr class="memdesc:a59842f582bd240a820fb5e44b956b121"><td class="mdescLeft"> </td><td class="mdescRight">Releases any images in the cache that aren't being referenced by active <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> objects. <a href="#a59842f582bd240a820fb5e44b956b121">More...</a><br /></td></tr>
<tr class="separator:a59842f582bd240a820fb5e44b956b121"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A global cache of images that have been loaded from files or memory. </p>
<p>If you're loading an image and may need to use the image in more than one place, this is used to allow the same image to be shared rather than loading multiple copies into memory.</p>
<p>Another advantage is that after images are released, they will be kept in memory for a few seconds before it is actually deleted, so if you're repeatedly loading/deleting the same image, it'll reduce the chances of having to reload it each time.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a>, <a class="el" href="classImageFileFormat.html" title="Base-class for codecs that can read and write image file formats such as PNG, JPEG, etc. ">ImageFileFormat</a> </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="acc266a65cf61dd0a2f68e68840b4a5c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc266a65cf61dd0a2f68e68840b4a5c4">§ </a></span>getFromFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classImage.html">Image</a> ImageCache::getFromFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads an image from a file, (or just returns the image if it's already cached). </p>
<p>If the cache already contains an image that was loaded from this file, that image will be returned. Otherwise, this method will try to load the file, add it to the cache, and return it.</p>
<p>Remember that the image returned is shared, so drawing into it might affect other things that are using it! If you want to draw on it, first call <a class="el" href="classImage.html#ad995cd253234063d22b604984e83489d" title="Makes sure that no other Image objects share the same underlying data as this one. ">Image::duplicateIfShared()</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>the file to try to load </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the image, or null if it there was an error loading it </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classImageCache.html#ac3e80d35b973c3cb47a031185ff56c06" title="Loads an image from an in-memory image file, (or just returns the image if it's already cached)...">getFromMemory</a>, getFromCache, <a class="el" href="classImageFileFormat.html#a1ce6ae82e06b40e9149d1ab73951ce1c" title="Tries to load an image from a stream. ">ImageFileFormat::loadFrom</a> </dd></dl>
</div>
</div>
<a id="ac3e80d35b973c3cb47a031185ff56c06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3e80d35b973c3cb47a031185ff56c06">§ </a></span>getFromMemory()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classImage.html">Image</a> ImageCache::getFromMemory </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>imageData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>dataSize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads an image from an in-memory image file, (or just returns the image if it's already cached). </p>
<p>If the cache already contains an image that was loaded from this block of memory, that image will be returned. Otherwise, this method will try to load the file, add it to the cache, and return it.</p>
<p>Remember that the image returned is shared, so drawing into it might affect other things that are using it! If you want to draw on it, first call <a class="el" href="classImage.html#ad995cd253234063d22b604984e83489d" title="Makes sure that no other Image objects share the same underlying data as this one. ">Image::duplicateIfShared()</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">imageData</td><td>the block of memory containing the image data </td></tr>
<tr><td class="paramname">dataSize</td><td>the data size in bytes </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the image, or an invalid image if it there was an error loading it </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classImageCache.html#ac3e80d35b973c3cb47a031185ff56c06" title="Loads an image from an in-memory image file, (or just returns the image if it's already cached)...">getFromMemory</a>, getFromCache, <a class="el" href="classImageFileFormat.html#a1ce6ae82e06b40e9149d1ab73951ce1c" title="Tries to load an image from a stream. ">ImageFileFormat::loadFrom</a> </dd></dl>
</div>
</div>
<a id="a4ebcfbc2287268f4312c8137a913bca4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ebcfbc2287268f4312c8137a913bca4">§ </a></span>getFromHashCode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classImage.html">Image</a> ImageCache::getFromHashCode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td>
<td class="paramname"><em>hashCode</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the cache for an image with a particular hashcode. </p>
<p>If there's an image in the cache with this hashcode, it will be returned, otherwise it will return an invalid image.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hashCode</td><td>the hash code that was associated with the image by <a class="el" href="classImageCache.html#aba7b8b9196a99296dc3900fb6d01f04a" title="Adds an image to the cache with a user-defined hash-code. ">addImageToCache()</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classImageCache.html#aba7b8b9196a99296dc3900fb6d01f04a" title="Adds an image to the cache with a user-defined hash-code. ">addImageToCache</a> </dd></dl>
</div>
</div>
<a id="aba7b8b9196a99296dc3900fb6d01f04a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba7b8b9196a99296dc3900fb6d01f04a">§ </a></span>addImageToCache()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void ImageCache::addImageToCache </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classImage.html">Image</a> & </td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="juce__MathsFunctions_8h.html#aecfc3c54bd29ad5964e1c1c3ccbf89df">int64</a> </td>
<td class="paramname"><em>hashCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds an image to the cache with a user-defined hash-code. </p>
<p>The image passed-in will be referenced (not copied) by the cache, so it's probably a good idea not to draw into it after adding it, otherwise this will affect all instances of it that may be in use.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">image</td><td>the image to add </td></tr>
<tr><td class="paramname">hashCode</td><td>the hash-code to associate with it </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classImageCache.html#a4ebcfbc2287268f4312c8137a913bca4" title="Checks the cache for an image with a particular hashcode. ">getFromHashCode</a> </dd></dl>
</div>
</div>
<a id="a7e8f2a2260acf7ca4f4a62c36ce99332"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e8f2a2260acf7ca4f4a62c36ce99332">§ </a></span>setCacheTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void ImageCache::setCacheTimeout </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>millisecs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the amount of time before an unused image will be removed from the cache. </p>
<p>By default this is about 5 seconds. </p>
</div>
</div>
<a id="a59842f582bd240a820fb5e44b956b121"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59842f582bd240a820fb5e44b956b121">§ </a></span>releaseUnusedImages()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void ImageCache::releaseUnusedImages </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases any images in the cache that aren't being referenced by active <a class="el" href="classImage.html" title="Holds a fixed-size bitmap. ">Image</a> objects. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__ImageCache_8h.html">juce_ImageCache.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|