Interface IRafCallbacksMap

Callbacks for Raf module events

interface IRafCallbacksMap {
    destroy: undefined;
    frame: {
        duration: number;
        fps: number;
        fpsFactor: number;
        lerpFactor: (factor: number) => number;
    };
    pause: undefined;
    play: undefined;
    props: undefined;
    toggle: undefined;
}

Hierarchy (View Summary)

Properties

destroy frame pause play props toggle

Properties

destroy

destroy: undefined

Triggered when the module is destroyed.

frame

frame: {
    duration: number;
    fps: number;
    fpsFactor: number;
    lerpFactor: (factor: number) => number;
}

Triggered on every animation frame

Type declaration

  • duration: number

    Duration of the last frame in ms

  • fps: number

    Current frames per second

  • fpsFactor: number

    Scaling coefficient based on a 60 FPS target

  • lerpFactor: (factor: number) => number

    Calculate linear interpolation factor to make animations run the same regardless of FPS

pause

pause: undefined

Triggered when the animation is paused

play

play: undefined

Triggered when the animation starts

props

props: undefined

Triggered when the module's properties are updated.

toggle

toggle: undefined

Triggered when play/pause state toggles

Settings

Member Visibility

On This Page

Properties