PointerSet

The pointers down on one surface, keyed by pointerId.

@internote/canvas-sdk/reactInterface
On this page
import { PointerSet } from '@internote/canvas-sdk/react';

#Fields

allTouchRequired
Whether every pointer down is a finger.
boolean
clearRequired
Forgets every pointer.
void
downRequired
Records a pointer going down.
void
hasRequired
Whether this pointer is one of them.
boolean
midpointRequired
The first two pointers' midpoint, or null with fewer than two down.
PointerPoint | null
moveRequired
Moves a pointer that is down, and returns where it was. null for a pointer the set does not hold, whose move is not this surface's.
PointerPoint | null
pointsRequired
The points in the order they went down.
PointerPoint[]
sizeRequired
How many pointers are down.
number
spreadRequired
The distance between the first two pointers, or null with fewer than two down.
number | null
upRequired
Forgets a pointer: lifted, or cancelled by the system.
void

Declared in packages/canvas-sdk/src/react/gestures/use-pointer-set.ts:39.

Last updated