Class CanvasDarknessEffects

options

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

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

Static layerOptions

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

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

  Returns {
      name: string;
  }

  • name: string

Static instance

• get instance(): CanvasLayer

• Return a reference to the active instance of this canvas layer

  Returns CanvasLayer

draw

• draw(options?): 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

  • Optional options: object = {}

    Options which configure how the layer is drawn

  Returns Promise<CanvasLayer>

tearDown

• tearDown(options?): Promise<CanvasLayer>

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

  Parameters

  • Optional options: object = {}

    Options which configure how the layer is deconstructed

  Returns Promise<CanvasLayer>