Skip to content

1681-engine / index / FrameStats

Class: FrameStats ​

Defined in: src/debug/FrameStats.ts:5

The last size frame times in a ring of numbers: pure, allocation-free, read by the debug overlay's graph and its FPS line. Averages are over the ring, so one long frame shows in max without wrecking the FPS shown.

Constructors ​

Constructor ​

ts
new FrameStats(size?): FrameStats;

Defined in: src/debug/FrameStats.ts:10

Parameters ​

ParameterTypeDefault value
sizenumber120

Returns ​

FrameStats

Properties ​

size ​

ts
readonly size: number = 120;

Defined in: src/debug/FrameStats.ts:10


times ​

ts
readonly times: Float32Array;

Defined in: src/debug/FrameStats.ts:6

Accessors ​

average ​

Get Signature ​

ts
get average(): number;

Defined in: src/debug/FrameStats.ts:30

Returns ​

number


count ​

Get Signature ​

ts
get count(): number;

Defined in: src/debug/FrameStats.ts:21

Returns ​

number


fps ​

Get Signature ​

ts
get fps(): number;

Defined in: src/debug/FrameStats.ts:43

Returns ​

number


max ​

Get Signature ​

ts
get max(): number;

Defined in: src/debug/FrameStats.ts:37

Returns ​

number

Methods ​

at() ​

ts
at(i): number;

Defined in: src/debug/FrameStats.ts:26

The i-th frame, oldest first.

Parameters ​

ParameterType
inumber

Returns ​

number


clear() ​

ts
clear(): void;

Defined in: src/debug/FrameStats.ts:48

Returns ​

void


push() ​

ts
push(ms): void;

Defined in: src/debug/FrameStats.ts:15

Records one frame's length in ms.

Parameters ​

ParameterType
msnumber

Returns ​

void

Released under the MIT License.