Share via

InputFilter class

  • Reference
Package:
@microsoft/live-share-canvas

Defines an input filter. Input filters are used to transform input points on the fly.

Methods

filterPoint(IPointerPoint)

Filters (transforms) the specified point.
reset(IPointerPoint)

Resets this filter. Some filters use information about previous points to transform the next point. reset will be called automatically by InkingManager when a new wet stroke begins.

Method Details

filterPoint(IPointerPoint)

Filters (transforms) the specified point.

function filterPoint(p: IPointerPoint): IPointerPoint

Parameters

p
IPointerPoint

The point to transform.

Returns

IPointerPoint

reset(IPointerPoint)

Resets this filter. Some filters use information about previous points to transform the next point. reset will be called automatically by InkingManager when a new wet stroke begins.

function reset(startPoint: IPointerPoint)

Parameters

startPoint
IPointerPoint

The new starting point.