Class BackgroundMask

[[include:Options/BackgroundMask.md]]

Implements

Index

Constructors

Properties

composite cover enable

Methods

Constructors

constructor

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

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?): void
This load method is used to load data in the classes used as generic
Parameters
- Optionaldata: RecursivePartial<IBackgroundMask>
  the input options
Returns void
Implementation of IOptionLoader.load
- Defined in Options/Classes/BackgroundMask/BackgroundMask.ts:35