<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_17) on Sun Nov 03 15:35:44 CET 2013 -->
<title>Pool (libgdx API)
</title>
<meta name="date" content="2013-11-03">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Pool (libgdx API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.
</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/Pool.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../index-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>
libgdx API
<style>
body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%; font-weight:bold }
.TableHeadingColor { background:#EEEEFF; }
a { text-decoration:none }
a:hover { text-decoration:underline }
a:link, a:visited { color:blue }
table { border:0px }
.TableRowColor td:first-child { border-left:1px solid black }
.TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
hr { border:0px; border-bottom:1px solid #333366; }
</style>
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/badlogic/gdx/utils/PerformanceCounters.html" title="class in com.badlogic.gdx.utils"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../com/badlogic/gdx/utils/Pool.Poolable.html" title="interface in com.badlogic.gdx.utils"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/utils/Pool.html" target="_top">Frames
</a></li>
<li><a href="Pool.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li><a href="#nested_class_summary">Nested
</a> |
</li>
<li><a href="#field_summary">Field
</a> |
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li><a href="#field_detail">Field
</a> |
</li>
<li><a href="#constructor_detail">Constr
</a> |
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.badlogic.gdx.utils
</div>
<h2 title="Class Pool" class="title">Class Pool
<T
></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object
</li>
<li>
<ul class="inheritance">
<li>com.badlogic.gdx.utils.Pool
<T
></li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:
</dt>
<dd><a href="../../../../com/badlogic/gdx/graphics/g2d/ParticleEffectPool.html" title="class in com.badlogic.gdx.graphics.g2d">ParticleEffectPool
</a>,
<a href="../../../../com/badlogic/gdx/utils/ReflectionPool.html" title="class in com.badlogic.gdx.utils">ReflectionPool
</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class
<span class="strong">Pool
<T
></span>
extends java.lang.Object
</pre>
<div class="block">A pool of objects that can be reused to avoid allocation.
</div>
<dl><dt><span class="strong">Author:
</span></dt>
<dd>Nathan Sweet
</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type
</th>
<th class="colLast" scope="col">Class and Description
</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/Pool.Poolable.html" title="interface in com.badlogic.gdx.utils">Pool.Poolable
</a></strong></code>
<div class="block">Objects implementing this interface will have
<a href="../../../../com/badlogic/gdx/utils/Pool.Poolable.html#reset()"><code>Pool.Poolable.reset()
</code></a> called when passed to
<a href="../../../../com/badlogic/gdx/utils/Pool.html#free(T)"><code>free(Object)
</code></a>.
</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type
</th>
<th class="colLast" scope="col">Field and Description
</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/Pool.html#max">max
</a></strong></code>
<div class="block">The maximum number of objects that will be pooled.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/Pool.html#peak">peak
</a></strong></code>
<div class="block">The highest number of free objects.
</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description
</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/badlogic/gdx/utils/Pool.html#Pool()">Pool
</a></strong>()
</code>
<div class="block">Creates a pool with an initial capacity of 16 and no maximum.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../com/badlogic/gdx/utils/Pool.html#Pool(int)">Pool
</a></strong>(int
initialCapacity)
</code>
<div class="block">Creates a pool with the specified initial capacity and no maximum.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/badlogic/gdx/utils/Pool.html#Pool(int, int)">Pool
</a></strong>(int
initialCapacity,
int
max)
</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type
</th>
<th class="colLast" scope="col">Method and Description
</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/Pool.html#clear()">clear
</a></strong>()
</code>
<div class="block">Removes all free objects from this pool.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/Pool.html#free(T)">free
</a></strong>(
<a href="../../../../com/badlogic/gdx/utils/Pool.html" title="type parameter in Pool">T
</a> object)
</code>
<div class="block">Puts the specified object in the pool, making it eligible to be returned by
<a href="../../../../com/badlogic/gdx/utils/Pool.html#obtain()"><code>obtain()
</code></a>.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/Pool.html#freeAll(com.badlogic.gdx.utils.Array)">freeAll
</a></strong>(
<a href="../../../../com/badlogic/gdx/utils/Array.html" title="class in com.badlogic.gdx.utils">Array
</a><<a href="../../../../com/badlogic/gdx/utils/Pool.html" title="type parameter in Pool">T
</a>> objects)
</code>
<div class="block">Puts the specified objects in the pool.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/Pool.html#getFree()">getFree
</a></strong>()
</code>
<div class="block">The number of objects available to be obtained.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract
<a href="../../../../com/badlogic/gdx/utils/Pool.html" title="type parameter in Pool">T
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/Pool.html#newObject()">newObject
</a></strong>()
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/utils/Pool.html" title="type parameter in Pool">T
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/Pool.html#obtain()">obtain
</a></strong>()
</code>
<div class="block">Returns an object from this pool.
</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class
java.lang.Object
</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail
</h3>
<a name="max">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>max
</h4>
<pre>public final
int max
</pre>
<div class="block">The maximum number of objects that will be pooled.
</div>
</li>
</ul>
<a name="peak">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>peak
</h4>
<pre>public
int peak
</pre>
<div class="block">The highest number of free objects. Can be reset any time.
</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail
</h3>
<a name="Pool()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Pool
</h4>
<pre>public
Pool()
</pre>
<div class="block">Creates a pool with an initial capacity of 16 and no maximum.
</div>
</li>
</ul>
<a name="Pool(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Pool
</h4>
<pre>public
Pool(int
initialCapacity)
</pre>
<div class="block">Creates a pool with the specified initial capacity and no maximum.
</div>
</li>
</ul>
<a name="Pool(int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Pool
</h4>
<pre>public
Pool(int
initialCapacity,
int
max)
</pre>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>max
</code> - The maximum number of free objects to store in this pool.
</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail
</h3>
<a name="newObject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newObject
</h4>
<pre>protected abstract
<a href="../../../../com/badlogic/gdx/utils/Pool.html" title="type parameter in Pool">T
</a> newObject()
</pre>
</li>
</ul>
<a name="obtain()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>obtain
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/utils/Pool.html" title="type parameter in Pool">T
</a> obtain()
</pre>
<div class="block">Returns an object from this pool. The object may be new (from
<a href="../../../../com/badlogic/gdx/utils/Pool.html#newObject()"><code>newObject()
</code></a>) or reused (previously
<a href="../../../../com/badlogic/gdx/utils/Pool.html#free(T)"><code>freed
</code></a>).
</div>
</li>
</ul>
<a name="free(java.lang.Object)">
<!-- -->
</a><a name="free(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>free
</h4>
<pre>public
void
free(
<a href="../../../../com/badlogic/gdx/utils/Pool.html" title="type parameter in Pool">T
</a> object)
</pre>
<div class="block">Puts the specified object in the pool, making it eligible to be returned by
<a href="../../../../com/badlogic/gdx/utils/Pool.html#obtain()"><code>obtain()
</code></a>. If the pool already contains
<a href="../../../../com/badlogic/gdx/utils/Pool.html#max"><code>max
</code></a> free objects, the specified object is reset but not added to the pool.
</div>
</li>
</ul>
<a name="freeAll(com.badlogic.gdx.utils.Array)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>freeAll
</h4>
<pre>public
void
freeAll(
<a href="../../../../com/badlogic/gdx/utils/Array.html" title="class in com.badlogic.gdx.utils">Array
</a><<a href="../../../../com/badlogic/gdx/utils/Pool.html" title="type parameter in Pool">T
</a>> objects)
</pre>
<div class="block">Puts the specified objects in the pool. Null objects within the array are silently ignored.
</div>
<dl><dt><span class="strong">See Also:
</span></dt><dd><a href="../../../../com/badlogic/gdx/utils/Pool.html#free(T)"><code>free(Object)
</code></a></dd></dl>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear
</h4>
<pre>public
void
clear()
</pre>
<div class="block">Removes all free objects from this pool.
</div>
</li>
</ul>
<a name="getFree()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getFree
</h4>
<pre>public
int
getFree()
</pre>
<div class="block">The number of objects available to be obtained.
</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/Pool.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../index-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>libgdx API
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/badlogic/gdx/utils/PerformanceCounters.html" title="class in com.badlogic.gdx.utils"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../com/badlogic/gdx/utils/Pool.Poolable.html" title="interface in com.badlogic.gdx.utils"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/utils/Pool.html" target="_top">Frames
</a></li>
<li><a href="Pool.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li><a href="#nested_class_summary">Nested
</a> |
</li>
<li><a href="#field_summary">Field
</a> |
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li><a href="#field_detail">Field
</a> |
</li>
<li><a href="#constructor_detail">Constr
</a> |
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
<div style="font-size:9pt"><i>
Copyright
© 2010-2013 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
</i></div>
</small></p>
</body>
</html>