voxolith

InputEvent

A normalised event, delivered to Input.on listeners. look carries raw mouse movement while the pointer is locked (no pointer events are sent then); source is the DOM event behind the others.

type InputEvent = 
  | {
  kind: "pointer";
  phase: PointerPhase;
  pointer: PointerState;
  source: Event;
}
  | {
  dx: number;
  dy: number;
  kind: "wheel";
  pinch: boolean;
  source: Event;
  x: number;
  y: number;
}
  | {
  code: string;
  kind: "key";
  phase: "down" | "up";
  repeat: boolean;
  source: Event;
}
  | {
  dx: number;
  dy: number;
  kind: "look";
};

Defined in: engine/src/input/core.ts:64

Union Members

Type Literal

{
  kind: "pointer";
  phase: PointerPhase;
  pointer: PointerState;
  source: Event;
}

Type Literal

{
  dx: number;
  dy: number;
  kind: "wheel";
  pinch: boolean;
  source: Event;
  x: number;
  y: number;
}

dx

dx: number;

Normalised pixel deltas.

dy

dy: number;

kind

kind: "wheel";

pinch

pinch: boolean;

ctrl+wheel: a trackpad pinch (or ctrl+scroll).

source

source: Event;

x

x: number;

y

y: number;

Type Literal

{
  code: string;
  kind: "key";
  phase: "down" | "up";
  repeat: boolean;
  source: Event;
}

Type Literal

{
  dx: number;
  dy: number;
  kind: "look";
}

On this page