Class: LinearGradient

Constructor

new LinearGradient(p1, p2, color_stops)

Creates a new LinearGradient with the given start point, end point, and ColorStops.

Parameters:

Name	Type	Description
`p1`	Point2D	The start point of the gradient.
`p2`	Point2D	The end point of the gradient.
`color_stops`	Array.<ColorStop>	The color stops of the gradient.

Source: pkg/index.js, line 2594

Classes

LinearGradient

Members

color_stops

Gets the ColorStops of the gradient.

Source: pkg/index.js, line 2697

color_stops

Sets the ColorStops of the gradient.

Source: pkg/index.js, line 2707

p1

The start point of the gradient.

Source: pkg/index.js, line 2619

p1

The start point of the gradient.

Source: pkg/index.js, line 2627

p2

The end point of the gradient.

Source: pkg/index.js, line 2636

p2

The end point of the gradient.

Source: pkg/index.js, line 2644

Methods

color_at(p) → {Color}

Gets the Color at a given point along the gradient.

Parameters:

Name	Type	Description
`p`	Point2D	The point to get the color at.

Source: pkg/index.js, line 2726

Returns:

The color at the given point.

Type:: Color

color_at_offset(position) → {Color}

Gets the Color at a given offset along the gradient.

Parameters:

Name	Type	Description
`position`	number	The offset to get the color at.

Source: pkg/index.js, line 2717

Returns:

The color at the given offset.

Type:: Color

(static) default_linear_gradient() → {LinearGradient}

Returns the default LinearGradient, which is a gradient from the origin to the origin with no ColorStops.

Source: pkg/index.js, line 2689

Returns:

The default linear gradient.

Type:: LinearGradient

(static) lerp(gradient1, gradient2, t) → {LinearGradient}

Linearly interpolates between two LinearGradients given a progress value.

Parameters:

Name	Type	Description
`gradient1`	LinearGradient	The first linear gradient.
`gradient2`	LinearGradient	The second linear gradient.
`t`	number	The progress value.

Source: pkg/index.js, line 2739

Returns:

The interpolated linear gradient.

Type:: LinearGradient

(static) single_color_gradient(p1, p2, color, repeatsopt) → {LinearGradient}

Returns the default LinearGradient, which is a gradient from the start to the end the same color.

Parameters:

Name	Type	Attributes	Description
`p1`	Point2D		The start point of the gradient.
`p2`	Point2D		The end point of the gradient.
`color`	Color		The color of the gradient.
`repeats`	number \| null	<optional>	Number of times to repeat the color.

Source: pkg/index.js, line 2675

Returns:

The default linear gradient.

Type:: LinearGradient