Documentation / @debuffjp/dev / FrameRecorder

Class: FrameRecorder

Defined in: dev/src/session.ts:38

Records a per-frame breakdown through lifecycle hooks (dev only). Fixed-size ring buffers, no allocation per frame. Also emits User Timing measures so phases show up in browser profilers.

Constructors

Constructor

new FrameRecorder(game, options?): FrameRecorder

Defined in: dev/src/session.ts:64

Parameters

game

Game

options?

size?

number

userTiming?

boolean

Returns

FrameRecorder

Properties

onFrame

onFrame: ((index) => void) | undefined

Defined in: dev/src/session.ts:62

Called after each recorded frame with its index (see get).

---

size

readonly size: number

Defined in: dev/src/session.ts:39

Accessors

length

Get Signature

get length(): number

Defined in: dev/src/session.ts:107

Number of recorded frames (up to size).

Returns

number

Methods

dispose()

dispose(): void

Defined in: dev/src/session.ts:140

Returns

void

---

get()

get(i): FrameSample | undefined

Defined in: dev/src/session.ts:112

Sample i frames ago (0 = latest).

Parameters

i

number

Returns

FrameSample | undefined

---

recent()

recent(n?): FrameSample[]

Defined in: dev/src/session.ts:131

The latest n samples, oldest first (JSON-friendly, for agents).

Parameters

n?

number = ...

Returns

FrameSample[]