Class: CanvasComponent

Marks a 2D root. Scene.CreateEntity auto-attaches UITransform + PivotOffset to any descendant. The reference resolution maps to the actual canvas via scaleMode each frame.

Extends

• Component

Constructors

Constructor

new CanvasComponent(
   referenceWidth?, 
   referenceHeight?, 
   scaleMode?
): CanvasComponent;

Parameters

Parameter	Type	Default value
referenceWidth	number	1080
referenceHeight	number	1920
scaleMode	CanvasScaleMode	CanvasScaleMode.Fit

Returns

CanvasComponent

Overrides

Component.constructor

Properties

Property	Modifier	Type	Default value	Inherited from
dirty	public	boolean	true	Component.dirty
enabled	public	boolean	true	Component.enabled
referenceHeight	public	number	undefined	-
referenceWidth	public	number	undefined	-
scaleMode	public	CanvasScaleMode	undefined	-