Class HiddenCanvasGroup

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

Hierarchy

Container<DisplayObject, this>
- HiddenCanvasGroup

Index

Properties

masks groupName

Methods

_draw _tearDown addMask invalidateMasks

Properties

masks

masks: Container<DisplayObject> = ...

The container which hold masks.

`Static`groupName

groupName: string = "hidden"

Methods

_draw

_draw(options: any): Promise<void>
Parameters
- options: any
Returns Promise<void>
Inherit Doc

_tearDown

_tearDown(options: any): Promise<void>
Parameters
- options: any
Returns Promise<void>
Inherit Doc

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.
- Optionalposition: number
  Position of the mask.
Returns void

invalidateMasks

invalidateMasks(): void
Invalidate the masks: flag them for rerendering.

Returns void