<!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>PerformanceCounter (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="PerformanceCounter (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/PerformanceCounter.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/PauseableThread.html" title="class in com.badlogic.gdx.utils"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../com/badlogic/gdx/utils/PerformanceCounters.html" title="class 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/PerformanceCounter.html" target="_top">Frames
</a></li>
<li><a href="PerformanceCounter.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>Nested
|
</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 PerformanceCounter" class="title">Class PerformanceCounter
</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object
</li>
<li>
<ul class="inheritance">
<li>com.badlogic.gdx.utils.PerformanceCounter
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class
<span class="strong">PerformanceCounter
</span>
extends java.lang.Object
</pre>
<div class="block">Class to keep track of the time and load (percentage of total time) a specific task takes.
Call
<a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#start()"><code>start()
</code></a> just before starting the task and
<a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#stop()"><code>stop()
</code></a> right after. You can do this
multiple times if required. Every render or update call
<a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#tick()"><code>tick()
</code></a> to update the values.
The
<a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#time"><code>time
</code></a> <a href="../../../../com/badlogic/gdx/math/FloatCounter.html" title="class in com.badlogic.gdx.math"><code>FloatCounter
</code></a> provides access to the minimum, maximum, average, total and current time
the task takes. Likewise for the
<a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#load"><code>load
</code></a> value, which is the percentage of the total time.
</div>
<dl><dt><span class="strong">Author:
</span></dt>
<dd>xoppa
</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== 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>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#current">current
</a></strong></code>
<div class="block">The current value, you can manually increase this using your own timing mechanism if needed,
if you do so, you also need to update
<a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#valid"><code>valid
</code></a>.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/FloatCounter.html" title="class in com.badlogic.gdx.math">FloatCounter
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#load">load
</a></strong></code>
<div class="block">The load value of this counter
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#name">name
</a></strong></code>
<div class="block">The name of this counter
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/math/FloatCounter.html" title="class in com.badlogic.gdx.math">FloatCounter
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#time">time
</a></strong></code>
<div class="block">The time value of this counter
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#valid">valid
</a></strong></code>
<div class="block">Flag to indicate that the current value is valid, you need to set this to true if using your own timing mechanism
</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/PerformanceCounter.html#PerformanceCounter(java.lang.String)">PerformanceCounter
</a></strong>(java.lang.String
name)
</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#PerformanceCounter(java.lang.String, int)">PerformanceCounter
</a></strong>(java.lang.String
name,
int
windowSize)
</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/PerformanceCounter.html#reset()">reset
</a></strong>()
</code>
<div class="block">Resets this performance counter to its defaults values.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#start()">start
</a></strong>()
</code>
<div class="block">Start counting, call this method just before performing the task you want to keep track of.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#stop()">stop
</a></strong>()
</code>
<div class="block">Stop counting, call this method right after you performed the task you want to keep track of.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#tick()">tick
</a></strong>()
</code>
<div class="block">Updates the time and load counters and resets the time.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#tick(float)">tick
</a></strong>(float
delta)
</code>
<div class="block">Updates the time and load counters and resets the time.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#toString()">toString
</a></strong>()
</code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/badlogic/gdx/utils/StringBuilder.html" title="class in com.badlogic.gdx.utils">StringBuilder
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#toString(com.badlogic.gdx.utils.StringBuilder)">toString
</a></strong>(
<a href="../../../../com/badlogic/gdx/utils/StringBuilder.html" title="class in com.badlogic.gdx.utils">StringBuilder
</a> sb)
</code>
<div class="block">Creates a string in the form of "name [time: value, load: value]"
</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, 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="time">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>time
</h4>
<pre>public final
<a href="../../../../com/badlogic/gdx/math/FloatCounter.html" title="class in com.badlogic.gdx.math">FloatCounter
</a> time
</pre>
<div class="block">The time value of this counter
</div>
</li>
</ul>
<a name="load">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>load
</h4>
<pre>public final
<a href="../../../../com/badlogic/gdx/math/FloatCounter.html" title="class in com.badlogic.gdx.math">FloatCounter
</a> load
</pre>
<div class="block">The load value of this counter
</div>
</li>
</ul>
<a name="name">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name
</h4>
<pre>public final
java.lang.String name
</pre>
<div class="block">The name of this counter
</div>
</li>
</ul>
<a name="current">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>current
</h4>
<pre>public
float current
</pre>
<div class="block">The current value, you can manually increase this using your own timing mechanism if needed,
if you do so, you also need to update
<a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#valid"><code>valid
</code></a>.
</div>
</li>
</ul>
<a name="valid">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>valid
</h4>
<pre>public
boolean valid
</pre>
<div class="block">Flag to indicate that the current value is valid, you need to set this to true if using your own timing mechanism
</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail
</h3>
<a name="PerformanceCounter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PerformanceCounter
</h4>
<pre>public
PerformanceCounter(java.lang.String
name)
</pre>
</li>
</ul>
<a name="PerformanceCounter(java.lang.String, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PerformanceCounter
</h4>
<pre>public
PerformanceCounter(java.lang.String
name,
int
windowSize)
</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail
</h3>
<a name="tick()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tick
</h4>
<pre>public
void
tick()
</pre>
<div class="block">Updates the time and load counters and resets the time. Call
<a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#start()"><code>start()
</code></a> to begin a new count.
The values are only valid after at least two calls to this method.
</div>
</li>
</ul>
<a name="tick(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tick
</h4>
<pre>public
void
tick(float
delta)
</pre>
<div class="block">Updates the time and load counters and resets the time. Call
<a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#start()"><code>start()
</code></a> to begin a new count.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>delta
</code> - The time since the last call to this method
</dd></dl>
</li>
</ul>
<a name="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start
</h4>
<pre>public
void
start()
</pre>
<div class="block">Start counting, call this method just before performing the task you want to keep track of.
Call
<a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#stop()"><code>stop()
</code></a> when done.
</div>
</li>
</ul>
<a name="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop
</h4>
<pre>public
void
stop()
</pre>
<div class="block">Stop counting, call this method right after you performed the task you want to keep track of.
Call
<a href="../../../../com/badlogic/gdx/utils/PerformanceCounter.html#start()"><code>start()
</code></a> again when you perform more of that task.
</div>
</li>
</ul>
<a name="reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset
</h4>
<pre>public
void
reset()
</pre>
<div class="block">Resets this performance counter to its defaults values.
</div>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString
</h4>
<pre>public
java.lang.String
toString()
</pre>
<dl>
<dt><strong>Overrides:
</strong></dt>
<dd><code>toString
</code> in class
<code>java.lang.Object
</code></dd>
</dl>
</li>
</ul>
<a name="toString(com.badlogic.gdx.utils.StringBuilder)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString
</h4>
<pre>public
<a href="../../../../com/badlogic/gdx/utils/StringBuilder.html" title="class in com.badlogic.gdx.utils">StringBuilder
</a> toString(
<a href="../../../../com/badlogic/gdx/utils/StringBuilder.html" title="class in com.badlogic.gdx.utils">StringBuilder
</a> sb)
</pre>
<div class="block">Creates a string in the form of "name [time: value, load: value]"
</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/PerformanceCounter.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/PauseableThread.html" title="class in com.badlogic.gdx.utils"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../com/badlogic/gdx/utils/PerformanceCounters.html" title="class 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/PerformanceCounter.html" target="_top">Frames
</a></li>
<li><a href="PerformanceCounter.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>Nested
|
</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>