@microsoft/live-share-canvas package

Represents a canvas suitable for "dry ink", i.e. the persistent drawing. DryCanvas renders synchonously.

Represents the base class from wet and dry canvases, implementing the common rendering logic.

Represents the base class for all canvases. InkingCanvas provides resizing, coordinate tramnslation and base drawingprimitives.

Handles user interaction with a canvas, and manages the rendering of wet and dry strokes.

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

Represents a collection of input filters.

A basic input event provider implementation.

Implements a jitter reduction filter, which straightens stroke by ignoring micro movements detected by the input device, mainly pens.

Represents a canvas that implements the laser pointer behavior.

Enables live and collaborative inking.

Represents a live (shared) cursor. Applications that want to customize the appearance of cursors on the screen should extend LiveCursor and override its renderedElement property to return a custom HTML element.

Implements a simple typed multicast event.

InputProvider implementation that hooks into a DOM element's pointer events.

Represents a concrete stroke object.

Represents a canvas suitable for "wet ink", i.e. an ongoing stroke.

Defines the arguments of the AddPointsEvent.

Defines options used by InkingManager.addStroke and InkingManager.removeStroke.

Defines the arguments of the BeginStrokeEvent.

Defines a brush as used to draw strokes.

Defines an RGB color

Defines a typed multicast event, i.e. an event that can have multiple listeners.

Defines a 2D point.

Represents a pointer event such as up, down or enter.

Representes a a pointer move event.

Defines the arguments of the PointerMovedEvent.

Defines a 2D point with pointer pressure.

Represents the raw data of a stroke.

Defines a rectangle.

Defines a segment between two points.

Defines a stroke, i.e. a collection of points that can be rendered on a canvas.

Defines a set of options when creating new strokes.

Encapsulates information about a user.

Defines a "wet" stroke, i.e. a stroke as it's being drawn.

Defines the shape of a brush's tip.

Defines brush types.

Defines the refernece point of a canvas. The reference point is the origin used for panning and zooming operations.

Defines a typed callback function used by multicast events.

Defines available inking tools.

Stroke modes.

Stroke types.

Darkens the given color by a certain intensity.

Expands the specified rectangle so it contains the specified point.

Converts a CSS color expressed in the #RRGGBB format into an IColor object

Computes the distance between two points.

Adjusts a size given a pointer pressure.

Computes the square of the distance between two points. This provides a cheaper way to compare multiple distances since it doesn't compute any square root.

Lightens the given color by a certain intensity.

Converts screen coordinates to viewport coordinates.

Converts an IColor object into its CSS rgba() representation.

Converts viewport coordinates to screen coordinates.