content/hifi-public/tony/docs/ResourceCache.html
Dale Glass 0d14e5a379 Initial data.
Needs a lot of cleanup. Data has been de-duplicated, and where identical copies existed, one of them
has been replaced with a symlink.

Some files have been excluded, such as binaries, installers and debug dumps. Some of that may still
be present.
2022-02-13 18:59:11 +01:00

1034 lines
No EOL
9.3 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: ResourceCache</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Namespace: ResourceCache</h1>
<section>
<header>
<h2>ResourceCache</h2>
</header>
<article>
<div class="container-overview">
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>numTotal</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">total number of total resources</td>
</tr>
<tr>
<td class="name"><code>numCached</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">total number of cached resource</td>
</tr>
<tr>
<td class="name"><code>sizeTotal</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">size in bytes of all resources</td>
</tr>
<tr>
<td class="name"><code>sizeCached</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">size in bytes of all cached resources</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".getNumCachedResources"><span class="type-signature">(static) </span>getNumCachedResources<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<div class="description">
Returns the total number of cached resources
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id=".getNumTotalResources"><span class="type-signature">(static) </span>getNumTotalResources<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<div class="description">
Returns the total number of resources
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id=".getResource"><span class="type-signature">(static) </span>getResource<span class="signature">(url, fallback)</span><span class="type-signature"> &rarr; {<a href="Resource.html">Resource</a>}</span></h4>
<div class="description">
Asynchronously loads a resource from the spedified URL and returns it.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">url of resource to load</td>
</tr>
<tr>
<td class="name"><code>fallback</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">fallback URL if load of the desired url fails</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Resource.html">Resource</a></span>
</dd>
</dl>
<h4 class="name" id=".getResourceList"><span class="type-signature">(static) </span>getResourceList<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
<div class="description">
Returns list of all resource urls
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;string></span>
</dd>
</dl>
<h4 class="name" id=".getSizeCachedResources"><span class="type-signature">(static) </span>getSizeCachedResources<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<div class="description">
Returns the total size in bytes of cached resources
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id=".getSizeTotalResources"><span class="type-signature">(static) </span>getSizeTotalResources<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<div class="description">
Returns the total size in bytes of all resources
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id=".prefetch"><span class="type-signature">(static) </span>prefetch<span class="signature">(url)</span><span class="type-signature"> &rarr; {<a href="Resource.html">Resource</a>}</span></h4>
<div class="description">
Prefetches a resource.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">url of resource to load</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Resource.html">Resource</a></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Resource.html">Resource</a></li></ul><h3>Namespaces</h3><ul><li><a href="Account.html">Account</a></li><li><a href="AnimationCache.html">AnimationCache</a></li><li><a href="Assets.html">Assets</a></li><li><a href="ResourceCache.html">ResourceCache</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Nov 09 2016 18:12:13 GMT-0800 (Pacific Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>