Type Alias ScreenComponent

Screen Component Properties.

type ScreenComponent = {
    enabled: boolean;
    referenceResolution: number[];
    resolution: number[];
    scaleBlend: number;
    scaleMode: string;
    screenSpace: boolean;
}

Properties

enabled: boolean

Whether the component is enabled.

true

referenceResolution: number[]

An array of 2 numbers that represents the reference resolution of the screen. The screen adjusts its size based on scaleMode.

[1280,720]

resolution: number[]

An array of 2 numbers that represents the resolution of the screen.

[1280,720]

scaleBlend: number

Adjusts screen size changes relative to window size changes. 0 adjusts width only, 1 adjusts height only, values in between adjust both.

0.5

scaleMode: string

Controls screen resizing with window size changes. Can be pc.SCALEMODE_BLEND for adjusting to window resolution or pc.SCALEMODE_NONE.

"blend"

screenSpace: boolean

If true, displays child Elements in 2D. Set false for a 3D screen.

true