Class BackgroundMask

[[include:Options/BackgroundMask.md]]

Implements

IBackgroundMask
IOptionLoader<IBackgroundMask>

Index

Constructors

constructor

new BackgroundMask(): BackgroundMask
Returns BackgroundMask
- Defined in Options/Classes/BackgroundMask.ts:26

Properties

composite

composite: GlobalCompositeOperation

Canvas composite operation values here: https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation

`Readonly`cover

cover: BackgroundMaskCover

Background covering color

enable

enable: boolean

Background mask enabling options

Methods

load

load(data?: RecursivePartial<IBackgroundMask>): void
Parameters
- Optionaldata: RecursivePartial<IBackgroundMask>
Returns void
Implementation of IOptionLoader.load
- Defined in Options/Classes/BackgroundMask.ts:32

Class BackgroundMask

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BackgroundMask

Properties

composite

`Readonly`cover

enable

Methods

load

Parameters

Returns void

Settings

On This Page

Class BackgroundMask

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BackgroundMask

Properties

composite

Readonlycover

enable

Methods

load

Parameters

Returns void

Settings

On This Page

`Readonly`cover