StrokeOptions

See source code
Table of contents

The options object for getStroke or getStrokePoints.

interface StrokeOptions {}

Properties

end

optional

Cap, taper and easing for the end of the line.

end?: {
  cap?: boolean;
  easing?(distance: number): number;
  taper?: boolean | number;
};

last

optional

Whether to handle the points as a completed stroke.

last?: boolean;

simulatePressure

optional

Whether to simulate pressure based on velocity.

simulatePressure?: boolean;

size

optional

The base size (diameter) of the stroke.

size?: number;

smoothing

optional

How much to soften the stroke's edges.

smoothing?: number;

start

optional

Cap, taper and easing for the start of the line.

start?: {
  cap?: boolean;
  easing?(distance: number): number;
  taper?: boolean | number;
};

streamline

optional
streamline?: number;

thinning

optional

The effect of pressure on the stroke's size.

thinning?: number;

Methods

easing

optional

An easing function to apply to each point's pressure.

Parameters

NameDescription

pressure

number;

Returns

number;

Prev
SolidPathBuilderOpts
Next
StrokePoint