Skip to main content

setFps

Updates the rendering frame rate. Persists and applies immediately.

Parameters

ParameterTypeDescription
fpsnumberThe target frame rate in frames per second (minimum 1)

Returns

Promise<void>

Example

await settings.setFps(30);
import { settings, shadowPanel } from "@hmcs/sdk";

// Low-power mode: reduce frame rate and dim overlay
await settings.setFps(15);
await shadowPanel.setAlpha(0.3);