Class BackgroundMaskCover

The background mask cover options

Implements

Index

Constructors

Properties

color? draw? element? image? opacity

Methods

Constructors

constructor

new BackgroundMaskCover(): BackgroundMaskCover
Returns BackgroundMaskCover

Properties

`Optional`color

color?: OptionsColor

The background color hiding all elements behind

`Optional`draw

draw?: (context: BackgroundDrawContext, delta: IDelta) => void

Custom draw callback for dynamic mask

`Optional`element

element?:
    | string
    | HTMLCanvasElement
    | OffscreenCanvas
    | HTMLVideoElement
    | HTMLImageElement

External element or CSS selector for dynamic mask source

`Optional`image

image?: string

The background image hiding all elements behind

opacity

opacity: number = 1

The opacity of the background

Methods

load

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