org.mini2Dx.core.util

Class PerformanceTracker

java.lang.Object

org.mini2Dx.core.util.PerformanceTracker

public class PerformanceTracker
extends java.lang.Object

Tracks the following performance metrics during gameplay:

• Updates per second
• Average update durations
• Frames per second
• Current memory usage

Constructor Summary

Constructors

Constructor and Description
PerformanceTracker()

Method Summary

Modifier and Type	Method and Description
void	draw(Graphics g, float x, float y) Draws the current values to screen
void	draw(Graphics g, float x, float y, float targetWidth, int horizontalAlign) Draws the current values to screen
void	drawInBottomLeft(Graphics g) Draws the current values to the bottom left of the screen
void	drawInBottomRight(Graphics g) Draws the current values to the bottom right of the screen
void	drawInTopLeft(Graphics g) Draws the current values to the top left of the screen
void	drawInTopRight(Graphics g) Draws the current values to the top right of the screen
long	getAvailableMemory() Returns the available memory inside the JVM
double	getAverageUpdateDuration() Returns the average duration of update()
int	getFramesPerSecond() Returns the number of frames per second
long	getTotalMemory() Returns the total memory allocated to the JVM
int	getUpdatesPerSecond() Returns the number of updates per second
long	getUsedMemory() Returns the remaining memory inside the JVM
void	markFrame() Internal usage only: marks a new frame
void	markUpdateBegin() Internal usage only: marks the beginning of update operations
void	markUpdateEnd() Internal usage only: marks the end of update operations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PerformanceTracker

public PerformanceTracker()

Method Detail

markUpdateBegin

public void markUpdateBegin()

Internal usage only: marks the beginning of update operations

markUpdateEnd

public void markUpdateEnd()

Internal usage only: marks the end of update operations

markFrame

public void markFrame()

Internal usage only: marks a new frame

getUpdatesPerSecond

public int getUpdatesPerSecond()

Returns the number of updates per second

Returns:

getFramesPerSecond

public int getFramesPerSecond()

Returns the number of frames per second

Returns:

getAverageUpdateDuration

public double getAverageUpdateDuration()

Returns the average duration of update()

Returns:

The average duration in nanoseconds

getTotalMemory

public long getTotalMemory()

Returns the total memory allocated to the JVM

Returns:

The value in bytes

getUsedMemory

public long getUsedMemory()

Returns the remaining memory inside the JVM

Returns:

The value in bytes

getAvailableMemory

public long getAvailableMemory()

Returns the available memory inside the JVM

Returns:

The value in bytes

draw

public void draw(Graphics g,
                 float x,
                 float y)

Draws the current values to screen

Parameters:

g - The Graphics context

x - The x coordinate to render at

y - The y coordinate to render at

draw

public void draw(Graphics g,
                 float x,
                 float y,
                 float targetWidth,
                 int horizontalAlign)

Draws the current values to screen

Parameters:

g - The Graphics context

x - The x coordinate to render at

y - The y coordinate to render at

targetWidth - The target width to render at, or, -1 to use auto-width

horizontalAlign - The text alignment. Note: Use Align to retrieve the appropriate value. If target width is set to -1 this option is ignored and the text is left aligned

drawInTopLeft

public void drawInTopLeft(Graphics g)

Draws the current values to the top left of the screen

Parameters:

g - The Graphics context

drawInTopRight

public void drawInTopRight(Graphics g)

Draws the current values to the top right of the screen

Parameters:

g - The Graphics context

drawInBottomLeft

public void drawInBottomLeft(Graphics g)

Draws the current values to the bottom left of the screen

Parameters:

g - The Graphics context

drawInBottomRight

public void drawInBottomRight(Graphics g)

Draws the current values to the bottom right of the screen

Parameters:

g - The Graphics context