useFps

testeddemo

Reactive FPS counter based on requestAnimationFrame. Reports a smoothed FPS value averaged over a configurable number of frames, and tracks min/max values.

Source Tests

Example

const { fps, min, max, reset } = useFps();

Demo

Loading demo…

Signature

export function useFps(options: UseFpsOptions ={ ... }

Parameters

Parameter	Type	Default	Description
`options`?	`UseFpsOptions`	`{}`	Configuration options

Returns

UseFpsReturn

Property	Type	Default	Description
`fps`	`Readonly<Ref<number>>`	—	Current frames per second (averaged over the last `every` frames)
`min`	`Readonly<Ref<number>>`	—	Minimum FPS recorded since the composable was created or last reset
`max`	`Readonly<Ref<number>>`	—	Maximum FPS recorded since the composable was created or last reset
`isActive`	`Readonly<Ref<boolean>>`	—	Whether the FPS counter is currently active
`reset`	`() => void`	—	Reset min/max tracking