LightingSystemOptions

Index

Properties

• ambientColor
• ambientIntensity
• pos
• screenElement
• size
• zIndex

Properties

optionalambientColor

ambientColor?: Color | null

Overrides EngineOptions.lighting's ambientColor for this scene's instance.

optionalambientIntensity

ambientIntensity?: number

Overrides EngineOptions.lighting's ambientIntensity for this scene's instance.

optionalpos

pos?: Vector

Fixed anchor screen positioning coordinate. When omitted the overlay is anchored to the top left of the full visible canvas (Screen.unsafeArea) every frame.

optionalscreenElement

screenElement?: ScreenElement

Hook an external ScreenElement host rather than provisioning an independent one. The caller becomes responsible for its position and size.

optionalsize

size?: { height: number; width: number }

Fixed resolution dimensions. Defaults to tracking the screen Screen.resolution when omitted.

---

Type declaration

• height: number

• width: number

optionalzIndex

zIndex?: number

The z-index of the provisioned lighting overlay. Defaults to 100.