@studiokeywi/banjo - v0.0.1
    Preparing search index...

    Interface RateLimitedLoop

    A rate limited loop attempts to run an update function on a consistent interval, and a render function as fast as the monitor's refresh rate

    interface RateLimitedLoop {
        pause: () => boolean;
        start: () => boolean;
        stop: () => boolean;
        get paused(): boolean;
        get running(): boolean;
    }
    Index

    Properties

    pause start stop

    Accessors

    paused running

    Properties

    pause: () => boolean

    Pause or unpause the loop. Unlike stopping, this persists the internal requestAnimationFrame calls

    start: () => boolean

    Start the rate limited loop

    stop: () => boolean

    Stop the rate limited loop

    Accessors

    • get paused(): boolean

      Whether the rate limited loop is currently paused

      Returns boolean

    • get running(): boolean

      Whether the rate limited loop is currently running

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors