Module technology.sola.engine

Package technology.sola.engine.core

Class GameLoop

java.lang.Object

technology.sola.engine.core.GameLoop

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

FixedUpdateGameLoop

@NullMarked
public abstract class GameLoop
extends Object
implements Runnable

GameLoop handles running a sequence of update and render commands at a target rate.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	GameLoop.FpsTracker	FpsTracker is a simple class for tracking update and frame ticks.

Field Summary

Fields

Modifier and Type	Field	Description
protected final float	deltaTime	The time since the last update.
protected final EventHub	eventHub	The EventHub instance.
protected final GameLoop.FpsTracker	fpsTracker	The GameLoop.FpsTracker instance.
protected long	previousLoopStartNanos	The previous time for when the previous loop started in nanoseconds.
protected final Runnable	renderMethod	Method to call each render frame.
protected float	updateCatchUpAccumulator	Holds accumulated lost time when the fixed update loop cannot keep up.
protected final Consumer<Float>	updateMethod	Method to call each update.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GameLoop(EventHub eventHub, Consumer<Float> updateMethod, Runnable renderMethod, int targetUpdatesPerSecond)	Creates a game loop instance with desired update and render logic at target updates per second.
protected	GameLoop(EventHub eventHub, Consumer<Float> updateMethod, Runnable renderMethod, int targetUpdatesPerSecond, boolean logFps)	Creates a game loop instance with desired update and render logic at target updates per second.

Method Summary

Modifier and Type	Method	Description
boolean	isPaused()
boolean	isRunning()
void	run()
protected abstract void	startLoop()	Called to start the main game loop.
void	stop()	Stops the game loop.

Methods inherited from class java.lang.Object

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

Field Details

eventHub

protected final EventHub eventHub

The EventHub instance.

fpsTracker

protected final GameLoop.FpsTracker fpsTracker

The GameLoop.FpsTracker instance.

updateMethod

protected final Consumer<Float> updateMethod

Method to call each update. The delta time is passed into the Consumer.

renderMethod

protected final Runnable renderMethod

Method to call each render frame.

deltaTime

protected final float deltaTime

The time since the last update.

previousLoopStartNanos

protected long previousLoopStartNanos

The previous time for when the previous loop started in nanoseconds.

updateCatchUpAccumulator

protected float updateCatchUpAccumulator

Holds accumulated lost time when the fixed update loop cannot keep up.

Constructor Details

GameLoop

protected GameLoop(EventHub eventHub,
 Consumer<Float> updateMethod,
 Runnable renderMethod,
 int targetUpdatesPerSecond)

Creates a game loop instance with desired update and render logic at target updates per second.

Parameters:

eventHub - the EventHub instance

updateMethod - the update method that is called each frame

renderMethod - the render method that is called each frame

targetUpdatesPerSecond - the target updates per second for the game loop

GameLoop

protected GameLoop(EventHub eventHub,
 Consumer<Float> updateMethod,
 Runnable renderMethod,
 int targetUpdatesPerSecond,
 boolean logFps)

Creates a game loop instance with desired update and render logic at target updates per second.

Parameters:

eventHub - the EventHub instance

updateMethod - the update method that is called each frame

renderMethod - the render method that is called each frame

targetUpdatesPerSecond - the target updates per second for the game loop

logFps - whether the fps should be logged each second or not

Method Details

run

public void run()

Specified by:

run in interface Runnable

startLoop

protected abstract void startLoop()

Called to start the main game loop.

isRunning

public boolean isRunning()

Returns:

true if the game loop is currently running

isPaused

public boolean isPaused()

Returns:

true if the game loop is paused

stop

public void stop()

Stops the game loop.