373 lines
16 KiB
HTML
373 lines
16 KiB
HTML
<!doctype html>
|
||
<html class="default no-js">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<title>Pool | @esengine/egret-framework</title>
|
||
<meta name="description" content="Documentation for @esengine/egret-framework">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<link rel="stylesheet" href="../assets/css/main.css">
|
||
</head>
|
||
<body>
|
||
<header>
|
||
<div class="tsd-page-toolbar">
|
||
<div class="container">
|
||
<div class="table-wrap">
|
||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||
<div class="field">
|
||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||
<input id="tsd-search-field" type="text" />
|
||
</div>
|
||
<ul class="results">
|
||
<li class="state loading">Preparing search index...</li>
|
||
<li class="state failure">The search index is not available</li>
|
||
</ul>
|
||
<a href="../index.html" class="title">@esengine/egret-framework</a>
|
||
</div>
|
||
<div class="table-cell" id="tsd-widgets">
|
||
<div id="tsd-filter">
|
||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||
<div class="tsd-filter-group">
|
||
<div class="tsd-select" id="tsd-filter-visibility">
|
||
<span class="tsd-select-label">All</span>
|
||
<ul class="tsd-select-list">
|
||
<li data-value="public">Public</li>
|
||
<li data-value="protected">Public/Protected</li>
|
||
<li data-value="private" class="selected">All</li>
|
||
</ul>
|
||
</div>
|
||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||
<input type="checkbox" id="tsd-filter-externals" checked />
|
||
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||
</div>
|
||
</div>
|
||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="tsd-page-title">
|
||
<div class="container">
|
||
<ul class="tsd-breadcrumb">
|
||
<li>
|
||
<a href="../globals.html">Globals</a>
|
||
</li>
|
||
<li>
|
||
<a href="../modules/_utils_pool_.html">"Utils/Pool"</a>
|
||
</li>
|
||
<li>
|
||
<a href="../modules/_utils_pool_.es.html">es</a>
|
||
</li>
|
||
<li>
|
||
<a href="_utils_pool_.es.pool.html">Pool</a>
|
||
</li>
|
||
</ul>
|
||
<h1>Class Pool<T></h1>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="container container-main">
|
||
<div class="row">
|
||
<div class="col-8 col-content">
|
||
<section class="tsd-panel tsd-comment">
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>用于池任何对象</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="tsd-panel tsd-type-parameters">
|
||
<h3>Type parameters</h3>
|
||
<ul class="tsd-type-parameters">
|
||
<li>
|
||
<h4>T</h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-hierarchy">
|
||
<h3>Hierarchy</h3>
|
||
<ul class="tsd-hierarchy">
|
||
<li>
|
||
<span class="target">Pool</span>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel-group tsd-index-group">
|
||
<h2>Index</h2>
|
||
<section class="tsd-panel tsd-index-panel">
|
||
<div class="tsd-index-content">
|
||
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
|
||
<h3>Properties</h3>
|
||
<ul class="tsd-index-list">
|
||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_utils_pool_.es.pool.html#_objectqueue" class="tsd-kind-icon">_object<wbr>Queue</a></li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-index-section ">
|
||
<h3>Methods</h3>
|
||
<ul class="tsd-index-list">
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_pool_.es.pool.html#clearcache" class="tsd-kind-icon">clear<wbr>Cache</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a href="_utils_pool_.es.pool.html#free" class="tsd-kind-icon">free</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a href="_utils_pool_.es.pool.html#obtain" class="tsd-kind-icon">obtain</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_pool_.es.pool.html#trimcache" class="tsd-kind-icon">trim<wbr>Cache</a></li>
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_pool_.es.pool.html#warmcache" class="tsd-kind-icon">warm<wbr>Cache</a></li>
|
||
</ul>
|
||
</section>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
|
||
<h2>Properties</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
|
||
<a name="_objectqueue" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> _object<wbr>Queue</h3>
|
||
<div class="tsd-signature tsd-kind-icon">_object<wbr>Queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Utils/Pool.ts#L6">src/Utils/Pool.ts:6</a></li>
|
||
</ul>
|
||
</aside>
|
||
</section>
|
||
</section>
|
||
<section class="tsd-panel-group tsd-member-group ">
|
||
<h2>Methods</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a name="clearcache" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> clear<wbr>Cache</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">clear<wbr>Cache<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Utils/Pool.ts#L34">src/Utils/Pool.ts:34</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>清除缓存</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
|
||
<a name="free" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> free</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">free<T><span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Utils/Pool.ts#L52">src/Utils/Pool.ts:52</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>将项推回堆栈</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||
<ul class="tsd-type-parameters">
|
||
<li>
|
||
<h4>T</h4>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>obj: <span class="tsd-signature-type">T</span></h5>
|
||
<div class="tsd-comment tsd-typography">
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
|
||
<a name="obtain" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> obtain</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">obtain<T><span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Utils/Pool.ts#L41">src/Utils/Pool.ts:41</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>如果可以的话，从堆栈中弹出一个项</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||
<ul class="tsd-type-parameters">
|
||
<li>
|
||
<h4>T</h4>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>type: <span class="tsd-signature-type">any</span></h5>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a name="trimcache" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> trim<wbr>Cache</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">trim<wbr>Cache<span class="tsd-signature-symbol">(</span>cacheCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Utils/Pool.ts#L26">src/Utils/Pool.ts:26</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>将缓存修剪为cacheCount项目</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>cacheCount: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography">
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a name="warmcache" class="tsd-anchor"></a>
|
||
<h3><span class="tsd-flag ts-flagStatic">Static</span> warm<wbr>Cache</h3>
|
||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<li class="tsd-signature tsd-kind-icon">warm<wbr>Cache<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, cacheCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
</ul>
|
||
<ul class="tsd-descriptions">
|
||
<li class="tsd-description">
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Utils/Pool.ts#L13">src/Utils/Pool.ts:13</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>预热缓存，使用最大的cacheCount对象填充缓存</p>
|
||
</div>
|
||
</div>
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameters">
|
||
<li>
|
||
<h5>type: <span class="tsd-signature-type">any</span></h5>
|
||
</li>
|
||
<li>
|
||
<h5>cacheCount: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography">
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
</div>
|
||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||
<nav class="tsd-navigation primary">
|
||
<ul>
|
||
<li class="globals ">
|
||
<a href="../globals.html"><em>Globals</em></a>
|
||
</li>
|
||
<li class="current tsd-kind-module">
|
||
<a href="../modules/_utils_pool_.html">"<wbr>Utils/<wbr>Pool"</a>
|
||
<ul>
|
||
<li class="current tsd-kind-namespace tsd-parent-kind-module">
|
||
<a href="../modules/_utils_pool_.es.html">es</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<nav class="tsd-navigation secondary menu-sticky">
|
||
<ul class="before-current">
|
||
</ul>
|
||
<ul class="current">
|
||
<li class="current tsd-kind-class tsd-parent-kind-namespace tsd-has-type-parameter">
|
||
<a href="_utils_pool_.es.pool.html" class="tsd-kind-icon">Pool</a>
|
||
<ul>
|
||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
|
||
<a href="_utils_pool_.es.pool.html#_objectqueue" class="tsd-kind-icon">_object<wbr>Queue</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a href="_utils_pool_.es.pool.html#clearcache" class="tsd-kind-icon">clear<wbr>Cache</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
|
||
<a href="_utils_pool_.es.pool.html#free" class="tsd-kind-icon">free</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static">
|
||
<a href="_utils_pool_.es.pool.html#obtain" class="tsd-kind-icon">obtain</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a href="_utils_pool_.es.pool.html#trimcache" class="tsd-kind-icon">trim<wbr>Cache</a>
|
||
</li>
|
||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||
<a href="_utils_pool_.es.pool.html#warmcache" class="tsd-kind-icon">warm<wbr>Cache</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul class="after-current">
|
||
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
|
||
<a href="../interfaces/_utils_pool_.es.ipoolable.html" class="tsd-kind-icon">IPoolable</a>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<footer class="with-border-bottom">
|
||
<div class="container">
|
||
<h2>Legend</h2>
|
||
<div class="tsd-legend-group">
|
||
<ul class="tsd-legend">
|
||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||
</ul>
|
||
<ul class="tsd-legend">
|
||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||
</ul>
|
||
<ul class="tsd-legend">
|
||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||
</ul>
|
||
<ul class="tsd-legend">
|
||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<div class="container tsd-generator">
|
||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||
</div>
|
||
<div class="overlay"></div>
|
||
<script src="../assets/js/main.js"></script>
|
||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||
</body>
|
||
</html> |