Interface IUseAnimationFrameProps

Hierarchy

  • Pick<NAnimationFrame.IChangeableProps, "fps" | "autoFpsFrames">
    • IUseAnimationFrameProps

Properties

autoFpsFrames? fps? onFrame onPause? onPlay?

Properties

Optional autoFpsFrames

autoFpsFrames?: number

The number of frames to test for detecting the real FPS when 'auto' is selected. This determines how many frames are measured before calculating the average FPS.

Default

10

Optional fps

fps?: number | "auto"

Frames per second (FPS) for the animation. If set to 'auto', the FPS will be dynamically determined based on the system's performance.

Default

'auto'

onFrame

onFrame: TUseAnimationFrameOnFrame

Event triggered on each animation frame

Optional onPause

onPause?: (() => void)

Type declaration

    • (): void

    • Event triggered when the animation is paused

      Returns void

Optional onPlay

onPlay?: (() => void)

Type declaration

    • (): void

    • Event triggered when the animation starts playing

      Returns void

Settings

Member Visibility

Theme

On This Page