ClassDebugger & Diagnostics@public

FlxFpsDisplay

Small dependency-free DOM display for render FPS and frame pacing.

export declare class FlxFpsDisplay

Constructors

constructor(options?: FlxFpsDisplayOptions)

Constructs a new instance of the FlxFpsDisplay class

Parameter	Type	Description
options	FlxFpsDisplayOptions	-

Properties

Property	Modifiers	Type	Description
fps	readonly	number	-
metrics	readonly	FlxFpsMetrics	Metrics from the most recently completed sampling window.

Methods

destroy()

destroy(): void

Returns: void

recordFrame()

recordFrame(elapsedMS: number, simulationSteps?: number): void

Record one completed render and the fixed updates executed before it.

Parameters:

Parameter	Type	Description
elapsedMS	number	-
simulationSteps	number	-

Returns: void

reset()

reset(): void

Clear collected samples, such as after returning from a background tab.

Returns: void