The filter used to mask visual effects on this layer
The container holding the lights.
A minimalist texture that holds the background color.
The base line mesh.
The cached container holding the illumination meshes.
Options for this layer instance.
Private
#backgroundThe background color rgb array.
Private
#drawingAn internal reference to a Promise in-progress to draw the CanvasLayer.
Private
#drawnIs the layer drawn?
To know if dynamic darkness level is active on this scene.
The illumination render texture.
Set or retrieve the illumination background color.
The canonical name of the CanvasLayer is the name of the constructor that is the immediate child of the defined baseClass for the layer type.
canvas.lighting.name -> "LightingLayer"
The name used by hooks to construct their hook string. Note: You should override this getter if hookName should not return the class constructor name.
Static
layerCustomize behaviors of this CanvasLayer by modifying some behaviors at a class level.
Static
instanceReturn a reference to the active instance of this canvas layer
Draw the canvas layer, rendering its internal components and returning a Promise. The Promise resolves to the drawn layer once its contents are successfully rendered.
Optional
options: object = {}Options which configure how the layer is drawn
Deconstruct data used in the current layer in preparation to re-draw the canvas
Optional
options: object = {}Options which configure how the layer is deconstructed
Protected
_createPrivate
#initialize
A CanvasLayer for displaying illumination visual effects