Class CanvasDarknessEffects

options

hookName

• get hookName(): string

  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.

  Returns string

name

• get name(): string

  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.

  Returns string

  Example

  canvas.lighting.name -> "LightingLayer"
  Copy

Staticinstance

• get instance(): CanvasLayer

  Return a reference to the active instance of this canvas layer

  Returns CanvasLayer

StaticlayerOptions

• get layerOptions(): { name: string; zIndex: number }

  Customize behaviors of this CanvasLayer by modifying some behaviors at a class level.

  Returns { name: string; zIndex: number }

draw

• draw(options?: object): Promise<CanvasLayer>

  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.

  Parameters

  • Optionaloptions: object = {}

    Options which configure how the layer is drawn

  Returns Promise<CanvasLayer>

getZIndex

• getZIndex(): number

  Get the zIndex that should be used for ordering this layer vertically relative to others in the same Container.

  Returns number

tearDown

• tearDown(options?: CanvasTearDownOptions): Promise<CanvasLayer>

  Deconstruct data used in the current layer in preparation to re-draw the canvas

  Parameters

  • Optionaloptions: CanvasTearDownOptions = {}

    Options which configure how the layer is deconstructed

  Returns Promise<CanvasLayer>