`PassCommitListener` Class

Interface for receiving notifications when a pass reaches its commit point. More...

Declaration

class helios::engine::runtime::gameloop::PassCommitListener { ... }

Derived Classes

class	GameLoop
	Central orchestrator for the game update cycle. More...

Public Destructor Index

	~PassCommitListener ()=default
	Virtual destructor for proper polymorphic cleanup. More...

Public Member Functions Index

void	onPassCommit (CommitPoint commitPoint, GameWorld &gameWorld, UpdateContext &updateContext) noexcept=0
	Called when a pass reaches its commit point. More...

Description

Interface for receiving notifications when a pass reaches its commit point.

The PassCommitListener provides a callback mechanism for responding to pass-level synchronization events within the game loop. When a Pass has a configured CommitPoint and finishes execution, registered listeners are notified via onPassCommit().

This interface is primarily implemented by the GameLoop class to handle:

Event buffer swapping: Making pass-level events readable to subsequent passes.
Command flushing: Executing deferred commands from the CommandBuffer.
Manager flushing: Processing queued requests (e.g., spawn/despawn operations).

The CommitPoint flags determine which synchronization actions are performed:

Flag	Action
PassEvents	Swaps pass event bus buffers
FlushCommands	Executes pending commands
FlushManagers	Processes manager requests
Structural	Combines all three flags

Integration with GameLoop

The GameLoop implements this interface and registers itself with each Phase. When a Pass with a commit point completes, the Phase calls onPassCommit(), allowing the GameLoop to perform the appropriate synchronization.

// In GameLoop::onPassCommit():

if ((commitPoint & CommitPoint::PassEvents) == CommitPoint::PassEvents) {

passEventBus_.swapBuffers();

}

if ((commitPoint & CommitPoint::FlushCommands) == CommitPoint::FlushCommands) {

commandBuffer_.flush(updateContext.gameWorld());

}

if ((commitPoint & CommitPoint::FlushManagers) == CommitPoint::FlushManagers) {

updateContext.gameWorld().flushManagers(updateContext);

}

See Also: GameLoop

See Also: Phase

See Also: Pass

See Also: CommitPoint

Definition at line 65 of file PassCommitListener.ixx.

Public Destructor