Interface: BackgroundSystemOptions

BackgroundSystemOptions

Options for the background system.

Properties:
Name Type Attributes Default Description
background ColorSource <optional>

Alias for backgroundColor

backgroundAlpha number <optional>
1

Transparency of the background color, value from 0 (fully transparent) to 1 (fully opaque).

backgroundColor ColorSource <optional>
'black'

The background color used to clear the canvas. See ColorSource for accepted color values.

clearBeforeRender boolean <optional>
true

Whether to clear the canvas before new render passes.

Members

background ColorSource

Alias for backgroundColor

backgroundAlpha number

Transparency of the background color, value from 0 (fully transparent) to 1 (fully opaque).

Default Value:
  • 1

backgroundColor ColorSource

The background color used to clear the canvas. See ColorSource for accepted color values.

Default Value:
  • 'black'

clearBeforeRender boolean

Whether to clear the canvas before new render passes.

Default Value:
  • true