Class BackgroundMask

[[include:Options/BackgroundMask.md]]

Implements

Index

Constructors

Properties

composite cover enable

Methods

Constructors

constructor

new BackgroundMask(): BackgroundMask
Returns BackgroundMask

Properties

composite

composite: GlobalCompositeOperation = "destination-out"

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

`Readonly`cover

cover: BackgroundMaskCover = ...

Background covering color

enable

enable: boolean = false

Background mask enabling options

Methods

load

load(data?: RecursivePartial<IBackgroundMask>): void
Loads the background mask options from the given data
Parameters
- Optionaldata: RecursivePartial<IBackgroundMask>
  the data to load from
Returns void
Implementation of IOptionLoader.load
- Defined in Options/Classes/BackgroundMask.ts:35