Class FrameStats

Implementation of a frame's stats. Meant to have values copied via FrameStats.reset, avoid creating instances of this every frame.

Hierarchy

FrameStats

Implements

FrameStatistics

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new FrameStats(): FrameStats

Returns FrameStats

Accessors

actors

get actors(): FrameActorStats

Implementation of FrameStatistics.actors
- Defined in Debug/Debug.ts:470
Gets the frame's actor statistics

Returns FrameActorStats

delta

get delta(): number
set delta(value: number): void

Implementation of FrameStatistics.delta
- Defined in Debug/Debug.ts:440
Gets the frame's delta (time since last frame)

Returns number
Implementation of FrameStatistics.delta
- Defined in Debug/Debug.ts:448
Sets the frame's delta (time since last frame). Internal use only.

internal
Parameters
- value: number
Returns void

duration

get duration(): FrameDurationStats

Implementation of FrameStatistics.duration
- Defined in Debug/Debug.ts:477
Gets the frame's duration statistics

Returns FrameDurationStats

fps

get fps(): number
set fps(value: number): void

Implementation of FrameStatistics.fps
- Defined in Debug/Debug.ts:455
Gets the frame's frames-per-second (FPS)

Returns number
Implementation of FrameStatistics.fps
- Defined in Debug/Debug.ts:463
Sets the frame's frames-per-second (FPS). Internal use only.

internal
Parameters
- value: number
Returns void

graphics

get graphics(): GraphicsStatistics

Implementation of FrameStatistics.graphics
- Defined in Debug/Debug.ts:491
Gets the frame's graphics statistics

Returns GraphicsStatistics

id

get id(): number
set id(value: number): void

Implementation of FrameStatistics.id
- Defined in Debug/Debug.ts:426
Gets the frame's id

Returns number
Implementation of FrameStatistics.id
- Defined in Debug/Debug.ts:433
Sets the frame's id

Parameters
- value: number
Returns void

physics

get physics(): PhysicsStats

Implementation of FrameStatistics.physics
- Defined in Debug/Debug.ts:484
Gets the frame's physics statistics

Returns PhysicsStats

Methods

clone

clone(): FrameStats

- Defined in Debug/Debug.ts:415
Provides a clone of this instance.

Returns FrameStats

reset

reset(otherStats?: FrameStatistics): void

- Defined in Debug/Debug.ts:390
Zero out values or clone other IFrameStat stats. Allows instance reuse.

Parameters
- Optional otherStats: FrameStatistics
Returns void