Class UILayer

UILayer is a container that manages scaling behavior for all its children

Example

const hudLayer = new UILayer({ scaleMode: UIScaleMode.ScaleUI });
scene.addChild(hudLayer);
hudLayer.addChild(tabs.container);

Hierarchy

Container
- UILayer

Index

Constructors

Methods

addChild updateScale

Constructors

constructor

new UILayer(options?: UILayerOptions): UILayer
Parameters
- options: UILayerOptions = {}
Returns UILayer
Overrides PIXI.Container.constructor
- Defined in UILayer.ts:40

Methods

addChild

addChild<T extends Container<ContainerChild>[]>(...children: T): T[0]
Add a child and trigger scale update if needed
Type Parameters
- T extends Container<ContainerChild>[]
Parameters
- ...children: T
Returns T[0]
Overrides PIXI.Container.addChild
- Defined in UILayer.ts:96

updateScale

updateScale(canvasWidth: number, canvasHeight: number): void
Update the layer's scale based on the current canvas size
Parameters
- canvasWidth: number
- canvasHeight: number
Returns void
- Defined in UILayer.ts:50