Engine API Reference - v2.23.0-beta.17
    Preparing search index...

    Class InputFrame<T>Alpha

    Represents an input frame, which contains a map of input deltas. The keys and lengths are fixed by the object passed to the constructor, for example { move: [0, 0, 0], rotate: [0, 0, 0] }, and read flushes every delta at once. A frame is the unit of exchange in this input system: InputSources are frames that fill themselves from a device, and an application combines their values into a frame with the shape an InputController expects.

    The shape of the input frame.

    Type Parameters

    • T extends Record<string, number[]>

      The shape of the input frame.

    Hierarchy (View Summary)

    Index
    deltas: { [K in string | number | symbol]: InputDelta } = ...
    • Alpha

      Returns the current frame state and resets the deltas to zero.

      Returns { [K in string | number | symbol]: number[] }

      • The flushed input frame with current deltas.