Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HiddenCanvasGroup

A specialized canvas group for rendering hidden containers before all others (like masks).

Hierarchy

  • any
    • HiddenCanvasGroup

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

eventMode

eventMode: string

masks

masks: Container = ...

The container which hold masks.

Static groupName

groupName: string = "hidden"
override

Methods

addMask

  • addMask(name: string, displayObject: DisplayObject, position: number): void

  • Add a mask to this group.

    Parameters

    • name: string

      Name of the mask.

    • displayObject: DisplayObject

      Display object to add.

    • position: number

    Returns void

draw

  • draw(): Promise<void>
  • override

    Returns Promise<void>

tearDown

  • tearDown(): Promise<void>
  • override

    Returns Promise<void>

Private #drawMasks

  • #drawMasks(): Promise<void>

  • Perform necessary draw operations.

    Returns Promise<void>

Private #createMasks

  • #createMasks(): void

  • Attach masks container to this canvas layer and create tile occlusion, vision masks and depth mask.

    Returns void