@univerjs/engine-render v0.1.17 • Docs

Class: PerformanceMonitor

Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window

Constructors

new PerformanceMonitor()

new PerformanceMonitor(frameSampleSize): PerformanceMonitor

constructor

Parameters

Parameter	Type	Default value	Description
`frameSampleSize`	`number`	`30`	The number of samples required to saturate the sliding window

Returns

PerformanceMonitor

Defined in

submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:33 (opens in a new tab)

Accessors

averageFPS

get averageFPS(): number

Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)

Returns

number

Defined in

submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:61 (opens in a new tab)

averageFrameTime

get averageFrameTime(): number

Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)

Returns

number

Defined in

submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:40 (opens in a new tab)

averageFrameTimeVariance

get averageFrameTimeVariance(): number

Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)

Returns

number

Defined in

submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:47 (opens in a new tab)

instantaneousFPS

get instantaneousFPS(): number

Returns the average framerate in frames per second using the most recent frame time

Returns

number

Defined in

submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:68 (opens in a new tab)

instantaneousFrameTime

get instantaneousFrameTime(): number

Returns the frame time of the most recent frame

Returns

number

Defined in

submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:54 (opens in a new tab)

isEnabled

get isEnabled(): boolean

Returns true if sampling is enabled

Returns

boolean

Defined in

submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:88 (opens in a new tab)

isSaturated

get isSaturated(): boolean

Returns true if enough samples have been taken to completely fill the sliding window

Returns

boolean

Defined in

submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:81 (opens in a new tab)

Methods

Now()

Now(): number

Returns

number

Defined in

submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:109 (opens in a new tab)

disable()

disable(): void

Disables contributions to the sliding window sample set Samples will not be interpolated over the disabled period

Returns

void

Defined in

submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:128 (opens in a new tab)

enable()

enable(): void

Enables contributions to the sliding window sample set

Returns

void

Defined in

submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:120 (opens in a new tab)

reset()

reset(): void

Resets performance monitor

Returns

void

Defined in

submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:137 (opens in a new tab)

sampleFrame()

sampleFrame(timeMs): void

Samples current frame

Parameters

Parameter	Type	Description
`timeMs`	`number`	A timestamp in milliseconds of the current frame to compare with other frames

Returns

void

Defined in

submodules/univer/packages/engine-render/src/basics/performance-monitor.ts:96 (opens in a new tab)

Path2 Rect