Skip to main content

Interface: FrameRateOptions

Use FrameRateOptions to set the desired frame rate and control how quickly the system reacts to GPU load changes.

The parameters below are relevant when some Views are using dynamic resolution scaling:

Properties​

headRoomRatio?​

optional headRoomRatio: number

Additional headroom for the GPU as a ratio of the targetFrameTime. Useful for taking into account constant costs like post-processing or GPU drivers on different platforms.

Default​

0.0

Defined in​

src/types/Renderer.ts:18


history?​

optional history: number

History size. Higher values tend to filter more (clamped to 31).

Default​

15

Defined in​

src/types/Renderer.ts:33


interval?​

optional interval: number

Desired frame interval in multiple of the refresh period, set in DisplayInfo (as 1 / DisplayInfo::refreshRate)

Default​

1

Defined in​

src/types/Renderer.ts:39


scaleRate?​

optional scaleRate: number

Rate at which the gpu load is adjusted to reach the target frame rate This value can be computed as 1 / N, where N is the number of frames needed to reach 64% of the target scale factor. Higher values make the dynamic resolution react faster.

Default​

1/8

Defined in​

src/types/Renderer.ts:27