Subversion Repositories AndroidProjects

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
356 chris 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
<!--NewPage-->
3
<HTML>
4
<HEAD>
5
<!-- Generated by javadoc (build 1.6.0_26) on Sun Jan 27 20:37:08 CET 2013 -->
6
<TITLE>
7
Pools (libgdx API)
8
</TITLE>
9
 
10
<META NAME="date" CONTENT="2013-01-27">
11
 
12
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
 
14
<SCRIPT type="text/javascript">
15
function windowTitle()
16
{
17
    if (location.href.indexOf('is-external=true') == -1) {
18
        parent.document.title="Pools (libgdx API)";
19
    }
20
}
21
</SCRIPT>
22
<NOSCRIPT>
23
</NOSCRIPT>
24
 
25
</HEAD>
26
 
27
<BODY BGCOLOR="white" onload="windowTitle();">
28
<HR>
29
 
30
 
31
<!-- ========= START OF TOP NAVBAR ======= -->
32
<A NAME="navbar_top"><!-- --></A>
33
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35
<TR>
36
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37
<A NAME="navbar_top_firstrow"><!-- --></A>
38
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39
  <TR ALIGN="center" VALIGN="top">
40
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Pools.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48
  </TR>
49
</TABLE>
50
</TD>
51
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52
 
53
                                libgdx API
54
                                <style>
55
                                body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
56
                                pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
57
                                h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%;  font-weight:bold }
58
                                .TableHeadingColor { background:#EEEEFF; }
59
                                a { text-decoration:none }
60
                                a:hover { text-decoration:underline }
61
                                a:link, a:visited { color:blue }
62
                                table { border:0px }
63
                                .TableRowColor td:first-child { border-left:1px solid black }
64
                                .TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
65
                                hr { border:0px; border-bottom:1px solid #333366; }
66
                                </style>
67
                        </EM>
68
</TD>
69
</TR>
70
 
71
<TR>
72
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
73
&nbsp;<A HREF="../../../../com/badlogic/gdx/utils/PooledLinkedList.html" title="class in com.badlogic.gdx.utils"><B>PREV CLASS</B></A>&nbsp;
74
&nbsp;<A HREF="../../../../com/badlogic/gdx/utils/ReflectionPool.html" title="class in com.badlogic.gdx.utils"><B>NEXT CLASS</B></A></FONT></TD>
75
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
76
  <A HREF="../../../../index.html?com/badlogic/gdx/utils/Pools.html" target="_top"><B>FRAMES</B></A>  &nbsp;
77
&nbsp;<A HREF="Pools.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
78
&nbsp;<SCRIPT type="text/javascript">
79
  <!--
80
  if(window==top) {
81
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
82
  }
83
  //-->
84
</SCRIPT>
85
<NOSCRIPT>
86
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
87
</NOSCRIPT>
88
 
89
 
90
</FONT></TD>
91
</TR>
92
<TR>
93
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
94
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
95
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
96
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
97
</TR>
98
</TABLE>
99
<A NAME="skip-navbar_top"></A>
100
<!-- ========= END OF TOP NAVBAR ========= -->
101
 
102
<HR>
103
<!-- ======== START OF CLASS DATA ======== -->
104
<H2>
105
<FONT SIZE="-1">
106
com.badlogic.gdx.utils</FONT>
107
<BR>
108
Class Pools</H2>
109
<PRE>
110
java.lang.Object
111
  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.badlogic.gdx.utils.Pools</B>
112
</PRE>
113
<HR>
114
<DL>
115
<DT><PRE>public class <B>Pools</B><DT>extends java.lang.Object</DL>
116
</PRE>
117
 
118
<P>
119
Stores a map of <A HREF="../../../../com/badlogic/gdx/utils/ReflectionPool.html" title="class in com.badlogic.gdx.utils"><CODE>ReflectionPool</CODE></A>s by type for convenient static access.
120
<P>
121
 
122
<P>
123
<DL>
124
<DT><B>Author:</B></DT>
125
  <DD>Nathan Sweet</DD>
126
</DL>
127
<HR>
128
 
129
<P>
130
 
131
<!-- ========== METHOD SUMMARY =========== -->
132
 
133
<A NAME="method_summary"><!-- --></A>
134
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
135
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
136
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
137
<B>Method Summary</B></FONT></TH>
138
</TR>
139
<TR BGCOLOR="white" CLASS="TableRowColor">
140
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141
<CODE>static&nbsp;void</CODE></FONT></TD>
142
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/utils/Pools.html#free(java.lang.Object)">free</A></B>(java.lang.Object&nbsp;object)</CODE>
143
 
144
<BR>
145
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Frees an object from the <A HREF="../../../../com/badlogic/gdx/utils/Pools.html#get(java.lang.Class)"><CODE>pool</CODE></A>.</TD>
146
</TR>
147
<TR BGCOLOR="white" CLASS="TableRowColor">
148
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149
<CODE>static&nbsp;void</CODE></FONT></TD>
150
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/utils/Pools.html#freeAll(com.badlogic.gdx.utils.Array)">freeAll</A></B>(<A HREF="../../../../com/badlogic/gdx/utils/Array.html" title="class in com.badlogic.gdx.utils">Array</A>&nbsp;objects)</CODE>
151
 
152
<BR>
153
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Frees the specified objects from the <A HREF="../../../../com/badlogic/gdx/utils/Pools.html#get(java.lang.Class)"><CODE>pool</CODE></A>.</TD>
154
</TR>
155
<TR BGCOLOR="white" CLASS="TableRowColor">
156
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157
<CODE>static
158
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
159
<TR ALIGN="right" VALIGN="">
160
<TD NOWRAP><FONT SIZE="-1">
161
<CODE>&lt;T&gt; <A HREF="../../../../com/badlogic/gdx/utils/Pool.html" title="class in com.badlogic.gdx.utils">Pool</A>&lt;T&gt;</CODE></FONT></TD>
162
</TR>
163
</TABLE>
164
</CODE></FONT></TD>
165
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/utils/Pools.html#get(java.lang.Class)">get</A></B>(java.lang.Class&lt;T&gt;&nbsp;type)</CODE>
166
 
167
<BR>
168
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a new or existing pool for the specified type, stored in a a Class to <A HREF="../../../../com/badlogic/gdx/utils/ReflectionPool.html" title="class in com.badlogic.gdx.utils"><CODE>ReflectionPool</CODE></A> map.</TD>
169
</TR>
170
<TR BGCOLOR="white" CLASS="TableRowColor">
171
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172
<CODE>static
173
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
174
<TR ALIGN="right" VALIGN="">
175
<TD NOWRAP><FONT SIZE="-1">
176
<CODE>&lt;T&gt; T</CODE></FONT></TD>
177
</TR>
178
</TABLE>
179
</CODE></FONT></TD>
180
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/utils/Pools.html#obtain(java.lang.Class)">obtain</A></B>(java.lang.Class&lt;T&gt;&nbsp;type)</CODE>
181
 
182
<BR>
183
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obtains an object from the <A HREF="../../../../com/badlogic/gdx/utils/Pools.html#get(java.lang.Class)"><CODE>pool</CODE></A>.</TD>
184
</TR>
185
</TABLE>
186
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
187
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
188
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
189
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
190
</TR>
191
<TR BGCOLOR="white" CLASS="TableRowColor">
192
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
193
</TR>
194
</TABLE>
195
&nbsp;
196
<P>
197
 
198
<!-- ============ METHOD DETAIL ========== -->
199
 
200
<A NAME="method_detail"><!-- --></A>
201
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
202
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
203
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
204
<B>Method Detail</B></FONT></TH>
205
</TR>
206
</TABLE>
207
 
208
<A NAME="get(java.lang.Class)"><!-- --></A><H3>
209
get</H3>
210
<PRE>
211
public static &lt;T&gt; <A HREF="../../../../com/badlogic/gdx/utils/Pool.html" title="class in com.badlogic.gdx.utils">Pool</A>&lt;T&gt; <B>get</B>(java.lang.Class&lt;T&gt;&nbsp;type)</PRE>
212
<DL>
213
<DD>Returns a new or existing pool for the specified type, stored in a a Class to <A HREF="../../../../com/badlogic/gdx/utils/ReflectionPool.html" title="class in com.badlogic.gdx.utils"><CODE>ReflectionPool</CODE></A> map. The max size of
214
 the pool used is 100.
215
<P>
216
<DD><DL>
217
</DL>
218
</DD>
219
</DL>
220
<HR>
221
 
222
<A NAME="obtain(java.lang.Class)"><!-- --></A><H3>
223
obtain</H3>
224
<PRE>
225
public static &lt;T&gt; T <B>obtain</B>(java.lang.Class&lt;T&gt;&nbsp;type)</PRE>
226
<DL>
227
<DD>Obtains an object from the <A HREF="../../../../com/badlogic/gdx/utils/Pools.html#get(java.lang.Class)"><CODE>pool</CODE></A>.
228
<P>
229
<DD><DL>
230
</DL>
231
</DD>
232
</DL>
233
<HR>
234
 
235
<A NAME="free(java.lang.Object)"><!-- --></A><H3>
236
free</H3>
237
<PRE>
238
public static void <B>free</B>(java.lang.Object&nbsp;object)</PRE>
239
<DL>
240
<DD>Frees an object from the <A HREF="../../../../com/badlogic/gdx/utils/Pools.html#get(java.lang.Class)"><CODE>pool</CODE></A>.
241
<P>
242
<DD><DL>
243
</DL>
244
</DD>
245
</DL>
246
<HR>
247
 
248
<A NAME="freeAll(com.badlogic.gdx.utils.Array)"><!-- --></A><H3>
249
freeAll</H3>
250
<PRE>
251
public static void <B>freeAll</B>(<A HREF="../../../../com/badlogic/gdx/utils/Array.html" title="class in com.badlogic.gdx.utils">Array</A>&nbsp;objects)</PRE>
252
<DL>
253
<DD>Frees the specified objects from the <A HREF="../../../../com/badlogic/gdx/utils/Pools.html#get(java.lang.Class)"><CODE>pool</CODE></A>.
254
<P>
255
<DD><DL>
256
</DL>
257
</DD>
258
</DL>
259
<!-- ========= END OF CLASS DATA ========= -->
260
<HR>
261
 
262
 
263
<!-- ======= START OF BOTTOM NAVBAR ====== -->
264
<A NAME="navbar_bottom"><!-- --></A>
265
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
266
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
267
<TR>
268
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
269
<A NAME="navbar_bottom_firstrow"><!-- --></A>
270
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
271
  <TR ALIGN="center" VALIGN="top">
272
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
273
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
274
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
275
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Pools.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
276
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
277
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
278
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
279
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
280
  </TR>
281
</TABLE>
282
</TD>
283
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
284
libgdx API</EM>
285
</TD>
286
</TR>
287
 
288
<TR>
289
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
290
&nbsp;<A HREF="../../../../com/badlogic/gdx/utils/PooledLinkedList.html" title="class in com.badlogic.gdx.utils"><B>PREV CLASS</B></A>&nbsp;
291
&nbsp;<A HREF="../../../../com/badlogic/gdx/utils/ReflectionPool.html" title="class in com.badlogic.gdx.utils"><B>NEXT CLASS</B></A></FONT></TD>
292
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
293
  <A HREF="../../../../index.html?com/badlogic/gdx/utils/Pools.html" target="_top"><B>FRAMES</B></A>  &nbsp;
294
&nbsp;<A HREF="Pools.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
295
&nbsp;<SCRIPT type="text/javascript">
296
  <!--
297
  if(window==top) {
298
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
299
  }
300
  //-->
301
</SCRIPT>
302
<NOSCRIPT>
303
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
304
</NOSCRIPT>
305
 
306
 
307
</FONT></TD>
308
</TR>
309
<TR>
310
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
311
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
312
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
313
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
314
</TR>
315
</TABLE>
316
<A NAME="skip-navbar_bottom"></A>
317
<!-- ======== END OF BOTTOM NAVBAR ======= -->
318
 
319
<HR>
320
 
321
                                <div style="font-size:9pt"><i>
322
                                Copyright 2010 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
323
                                </i></div>
324
 
325
</BODY>
326
</HTML>