tiny-ecs
Version:
A mean lean Entity-Component-System library.
710 lines (199 loc) • 8.51 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: ObjectPool</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">Class: ObjectPool</h1>
<section>
<header>
<h2>
ObjectPool
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="ObjectPool"><span class="type-signature"></span>new ObjectPool<span class="signature">(T)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>T</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ObjectPool.js.html">ObjectPool.js</a>, <a href="ObjectPool.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="aquire"><span class="type-signature"></span>aquire<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Get a pooled object
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ObjectPool.js.html">ObjectPool.js</a>, <a href="ObjectPool.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="expand"><span class="type-signature"></span>expand<span class="signature">(Amount)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>Amount</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">of new objects to allocate for this pool.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ObjectPool.js.html">ObjectPool.js</a>, <a href="ObjectPool.js.html#line46">line 46</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="release"><span class="type-signature"></span>release<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Return an object back to the pool.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ObjectPool.js.html">ObjectPool.js</a>, <a href="ObjectPool.js.html#line38">line 38</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="totalFree"><span class="type-signature"></span>totalFree<span class="signature">()</span><span class="type-signature"> → {Number}</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ObjectPool.js.html">ObjectPool.js</a>, <a href="ObjectPool.js.html#line64">line 64</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Total number of objects currently available.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="totalSize"><span class="type-signature"></span>totalSize<span class="signature">()</span><span class="type-signature"> → {Number}</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ObjectPool.js.html">ObjectPool.js</a>, <a href="ObjectPool.js.html#line56">line 56</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Total amount of allocated objects (available and in-use).
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="totalUsed"><span class="type-signature"></span>totalUsed<span class="signature">()</span><span class="type-signature"> → {Number}</span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ObjectPool.js.html">ObjectPool.js</a>, <a href="ObjectPool.js.html#line72">line 72</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Total number of objects currently in-use.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Entity.html">Entity</a></li><li><a href="EntityManager.html">EntityManager</a></li><li><a href="Group.html">Group</a></li><li><a href="ObjectPool.html">ObjectPool</a></li><li><a href="QuadTree.html">QuadTree</a></li><li><a href="Spatial.html">Spatial</a></li><li><a href="Vec2.html">Vec2</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha3</a> on Wed Jan 29 2014 01:06:20 GMT-0600 (CST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>