Class: Style

Constructor

new Style(coloropt, linear_gradientopt, radial_gradientopt, imageopt)

Creates a new Style with the given color, linear gradient, radial gradient, or image. It must have exactly one of these.

Parameters:

Name	Type	Attributes	Description
`color`	Color \| null	<optional>	The color of the style, if provided.
`linear_gradient`	LinearGradient \| null	<optional>	The linear gradient of the style, if provided.
`radial_gradient`	RadialGradient \| null	<optional>	The radial gradient of the style, if provided.
`image`	ImageBitmap \| null	<optional>	The image of the style, if provided.

Source: pkg/index.js, line 4004

Classes

Style

Members

color

Gets the Color of the style, if it's a color.

Source: pkg/index.js, line 4134

color

Sets the style to a Color.

Source: pkg/index.js, line 4142

image

Gets the ImageBitmap of the style, if it's an image.

Source: pkg/index.js, line 4185

image

Sets the style to an ImageBitmap.

Source: pkg/index.js, line 4193

linear_gradient

Gets the LinearGradient of the style, if it's a linear gradient.

Source: pkg/index.js, line 4151

linear_gradient

Sets the style to a LinearGradient.

Source: pkg/index.js, line 4159

radial_gradient

Gets the RadialGradient of the style, if it's a radial gradient.

Source: pkg/index.js, line 4168

radial_gradient

Sets the style to a RadialGradient.

Source: pkg/index.js, line 4176

Methods

clone() → {Style}

Clones the Style.

Source: pkg/index.js, line 4065

Returns:

The cloned style.

Type:: Style

color_at(p) → {Color}

Gets the Color at a given point.

Parameters:

Name	Type	Description
`p`	Point2D	The x coordinate of the point.

Source: pkg/index.js, line 4203

Returns:

The color at the given point.

Type:: Color

fade(amount) → {Style}

Fades the Style by a given amount.

Parameters:

Name	Type	Description
`amount`	number	The amount to fade the style by.

Source: pkg/index.js, line 4126

Returns:

The faded style.

Type:: Style

(static) default_style() → {Style}

Returns the default Style, which is a color with the default color.

Source: pkg/index.js, line 4117

Returns:

The default style.

Type:: Style

(static) from_color(color) → {Style}

Creates a new Style with the given color.

Parameters:

Name	Type	Description
`color`	Color	The color of the style.

Source: pkg/index.js, line 4074

Returns:

A new style from the color.

Type:: Style

(static) from_image(image) → {Style}

Creates a new Style with the given image.

Parameters:

Name	Type	Description
`image`	ImageBitmap	The image of the style.

Source: pkg/index.js, line 4107

Returns:

A new style from the image.

Type:: Style

(static) from_linear_gradient(gradient) → {Style}

Creates a new Style with the given linear gradient.

Parameters:

Name	Type	Description
`gradient`	LinearGradient	The linear gradient of the style.

Source: pkg/index.js, line 4085

Returns:

A new style from the linear gradient.

Type:: Style

(static) from_radial_gradient(gradient) → {Style}

Creates a new Style with the given radial gradient.

Parameters:

Name	Type	Description
`gradient`	RadialGradient

Source: pkg/index.js, line 4096

Returns:

A new style from the radial gradient.

Type:: Style

(static) lerp(style1, style2, t, xopt, yopt, widthopt, heightopt, data_widthopt, data_heightopt) → {Style}

Linearly interpolates between two Styles given a progress value.

Parameters:

Name	Type	Attributes	Description
`style1`	Style		The first style.
`style2`	Style		The second style.
`t`	number		The progress value.
`x`	number \| null	<optional>	Top left x coordinate of the bitmap. Must be provided if both styles are images.
`y`	number \| null	<optional>	Top left y coordinate of the bitmap. Must be provided if both styles are images.
`width`	number \| null	<optional>	Width of the bitmap. Must be provided if both styles are images.
`height`	number \| null	<optional>	Height of the bitmap. Must be provided if both styles are images.
`data_width`	number \| null	<optional>	Number of pixels in a row of the bitmap. Must be provided if both styles are different kinds of gradients or one of them is an image.
`data_height`	number \| null	<optional>	Number of pixels in a column of the bitmap. Must be provided if both styles are different kinds of gradients or one of them is an image.

Source: pkg/index.js, line 4222

Returns:

The interpolated style.

Type:: Style