Interface PointerInput

Primary pointer state; read it in your frame callback, then reset its deltas.

interface PointerInput {
    buttons: number;
    deltaX: number;
    deltaY: number;
    pointerId: number | null;
    pointerType: string;
    wheelDeltaMode: number;
    wheelX: number;
    wheelY: number;
    wheelZ: number;
    x: number;
    y: number;
}

Index

Properties

buttons deltaX deltaY pointerId pointerType wheelDeltaMode wheelX wheelY wheelZ x y

Properties

buttons

buttons: number

DOM held-button mask: primary 1, secondary 2, auxiliary 4.

deltaX

deltaX: number

Accumulated horizontal client motion, or movementX while pointer-locked.

deltaY

deltaY: number

Accumulated vertical client motion, or movementY while pointer-locked.

pointerId

pointerId: number | null

Last observed primary pointer, or null after cancellation/focus loss.

pointerType

pointerType: string

Last pointer's DOM type, or empty after cancellation/focus loss.

wheelDeltaMode

wheelDeltaMode: number

DOM wheel units: 0 pixels, 1 lines, 2 pages.

wheelX

wheelX: number

Raw wheel deltas for the latest contiguous deltaMode batch.

wheelY

wheelY: number

Raw wheel delta in the units identified by wheelDeltaMode.

wheelZ

wheelZ: number

Raw wheel delta in the units identified by wheelDeltaMode.

x

x: number

Element-local CSS pixel coordinates, not drawing-buffer coordinates.

y

y: number

Element-local CSS pixel coordinate.