libGDX 1.14.2 · com.badlogic.gdx.utils.PerformanceCounter

Class to keep track of the time and load (percentage of total time) a specific task takes. Call start() just before starting the task and stop() right after. You can do this multiple times if required. Every render or update call tick() to update the values. The time FloatCounter provides access to the minimum, maximum, average, total and current time (in seconds) the task takes. Likewise for the load value, which is the percentage of the total time.

Field Summary

Modifier and Type	Field and Description
public float	current The current value in seconds, you can manually increase this using your own timing mechanism if needed, if you do so, you also need to update `valid`.
private long	lastTick
public final FloatCounter	load The load value of this counter
public final String	name The name of this counter
private static final float	nano2seconds
private long	startTime
public final FloatCounter	time The time value of this counter (seconds)
public boolean	valid Flag to indicate that the current value is valid, you need to set this to true if using your own timing mechanism

Constructor Summary

Access	Constructor and Description
public	PerformanceCounter(final String name)
public	PerformanceCounter(final String name, final int windowSize)

Method Summary

Modifier and Type	Method and Description
public void	reset() Resets this performance counter to its defaults values.
public void	start() Start counting, call this method just before performing the task you want to keep track of.
public void	stop() Stop counting, call this method right after you performed the task you want to keep track of.
public void	tick() Updates the time and load counters and resets the time.
public void	tick(final float The time since the last call to this method delta) Updates the time and load counters and resets the time.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public StringBuilder	toString(final StringBuilder sb) Creates a string in the form of "name [time: value, load: value]"

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

current	back to summary
public float current The current value in seconds, you can manually increase this using your own timing mechanism if needed, if you do so, you also need to update `valid`.

lastTick	back to summary
private long lastTick

load	back to summary
public final FloatCounter load The load value of this counter

name	back to summary
public final String name The name of this counter

nano2seconds	back to summary
private static final float nano2seconds

startTime	back to summary
private long startTime

time	back to summary
public final FloatCounter time The time value of this counter (seconds)

valid	back to summary
public boolean valid Flag to indicate that the current value is valid, you need to set this to true if using your own timing mechanism

Constructor Detail

PerformanceCounter	back to summary
public PerformanceCounter(final String name)

PerformanceCounter	back to summary
public PerformanceCounter(final String name, final int windowSize)

Method Detail

reset	back to summary
public void reset() Resets this performance counter to its defaults values.

start	back to summary
public void start() Start counting, call this method just before performing the task you want to keep track of. Call `stop()` when done.

stop	back to summary
public void stop() Stop counting, call this method right after you performed the task you want to keep track of. Call `start()` again when you perform more of that task.

tick	back to summary
public void tick() Updates the time and load counters and resets the time. Call `start()` to begin a new count. The values are only valid after at least two calls to this method.

tick back to summary

tick	back to summary
public void tick(final float delta) Updates the time and load counters and resets the time. Call `start()` to begin a new count. Parameters delta:float The time since the last call to this method

public void tick(final float delta)

Updates the time and load counters and resets the time. Call start() to begin a new count.

Parameters

delta:float: The time since the last call to this method

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override