English

useFps

Tags:

A React Hook that returns the current frames per second (FPS) of the browser.

Demo

Active:

false

FPS:

See API for more details.

Click links below to view source on GitHub.

const { fps, ...controls } = useFps(options)

export type UseFpsOptions = {
  /**
   * Calculate the FPS on every x frames.
   *
   * @defaultValue 10
   */
  every?: number
}

Retuerns contain Pausable instance that can be paused, resumed.

See Pausable for more details.

export type UseFpsReturns = Pausable & {
  /**
   * Current FPS
   */
  fps: number
}

ON THIS PAGE