Class: Background

Background()

Draw command to clear and render the background.

Constructor

new Background()

Source:

draw/background.mjs, line 7

Classes

Background
Background

Methods

color(color) → {Background}

Clear the background with the given color.

Parameters:

Name	Type	Description
`color`	Color	the color

Source:

draw/background.mjs, line 20

Returns:

- itself

Type: Background

color(color) → {Background}

Clear the background with the given color.

Parameters:

Name	Type	Description
`color`	Color	the color

Source:

draw/background.mjs, line 20

Returns:

- itself

Type: Background

hsl(h, s, l) → {Background}

Clear the background with the given color. Expects float values in the range of 0 to 1.0.

Parameters:

Name	Type	Description
`h`	number	the hue value as float
`s`	number	the saturation value as float
`l`	number	the luminance value as float

Source:

draw/background.mjs, line 68

Returns:

- itself

Type: Background

hsl(h, s, l) → {Background}

Clear the background with the given color. Expects float values in the range of 0 to 1.0.

Parameters:

Name	Type	Description
`h`	number	the hue value as float
`s`	number	the saturation value as float
`l`	number	the luminance value as float

Source:

draw/background.mjs, line 68

Returns:

- itself

Type: Background

rgb(r, g, b) → {Background}

Clear the background with the given color. The alpha value is set to 1.0.

Parameters:

Name	Type	Description
`r`	number	the red value as float
`g`	number	the green value as float
`b`	number	the blue value as float

Source:

draw/background.mjs, line 42

Returns:

- itself

Type: Background

rgb(r, g, b) → {Background}

Clear the background with the given color. The alpha value is set to 1.0.

Parameters:

Name	Type	Description
`r`	number	the red value as float
`g`	number	the green value as float
`b`	number	the blue value as float

Source:

draw/background.mjs, line 42

Returns:

- itself

Type: Background

rgba(r, g, b, a) → {Background}

Clear the background with the given color.

Parameters:

Name	Type	Description
`r`	number	the red value as float
`g`	number	the green value as float
`b`	number	the blue value as float
`a`	number	the alpha value as float

Source:

draw/background.mjs, line 55

Returns:

- itself

Type: Background

rgba(r, g, b, a) → {Background}

Clear the background with the given color.

Parameters:

Name	Type	Description
`r`	number	the red value as float
`g`	number	the green value as float
`b`	number	the blue value as float
`a`	number	the alpha value as float

Source:

draw/background.mjs, line 55

Returns:

- itself

Type: Background

transparent() → {Background}

Makes the background clear transparent.

Source:

draw/background.mjs, line 29

Returns:

Type: Background

transparent() → {Background}

Makes the background clear transparent.

Source:

draw/background.mjs, line 29

Returns:

Type: Background

BackgroundBackground()

Draw command to clear and render the background.

Constructor

new Background()

Source:

draw/background.mjs, line 7

Classes

Background
Background

Methods

color(color) → {Background}

Clear the background with the given color.

Parameters:

Name	Type	Description
`color`	Color	the color

Source:

draw/background.mjs, line 20

Returns:

- itself

Type: Background

color(color) → {Background}

Clear the background with the given color.

Parameters:

Name	Type	Description
`color`	Color	the color

Source:

draw/background.mjs, line 20

Returns:

- itself

Type: Background

hsl(h, s, l) → {Background}

Clear the background with the given color. Expects float values in the range of 0 to 1.0.

Parameters:

Name	Type	Description
`h`	number	the hue value as float
`s`	number	the saturation value as float
`l`	number	the luminance value as float

Source:

draw/background.mjs, line 68

Returns:

- itself

Type: Background

hsl(h, s, l) → {Background}

Clear the background with the given color. Expects float values in the range of 0 to 1.0.

Parameters:

Name	Type	Description
`h`	number	the hue value as float
`s`	number	the saturation value as float
`l`	number	the luminance value as float

Source:

draw/background.mjs, line 68

Returns:

- itself

Type: Background

rgb(r, g, b) → {Background}

Clear the background with the given color. The alpha value is set to 1.0.

Parameters:

Name	Type	Description
`r`	number	the red value as float
`g`	number	the green value as float
`b`	number	the blue value as float

Source:

draw/background.mjs, line 42

Returns:

- itself

Type: Background

rgb(r, g, b) → {Background}

Clear the background with the given color. The alpha value is set to 1.0.

Parameters:

Name	Type	Description
`r`	number	the red value as float
`g`	number	the green value as float
`b`	number	the blue value as float

Source:

draw/background.mjs, line 42

Returns:

- itself

Type: Background

rgba(r, g, b, a) → {Background}

Clear the background with the given color.

Parameters:

Name	Type	Description
`r`	number	the red value as float
`g`	number	the green value as float
`b`	number	the blue value as float
`a`	number	the alpha value as float

Source:

draw/background.mjs, line 55

Returns:

- itself

Type: Background

rgba(r, g, b, a) → {Background}

Clear the background with the given color.

Parameters:

Name	Type	Description
`r`	number	the red value as float
`g`	number	the green value as float
`b`	number	the blue value as float
`a`	number	the alpha value as float

Source:

draw/background.mjs, line 55

Returns:

- itself

Type: Background

transparent() → {Background}

Makes the background clear transparent.

Source:

draw/background.mjs, line 29

Returns:

Type: Background

transparent() → {Background}

Makes the background clear transparent.

Source:

draw/background.mjs, line 29

Returns:

Type: Background