Skip to content
On this page

Interface: LightProps ​

WebSG.LightProps

LightProps is an interface that defines the properties for creating a Light instance.

Table of contents ​

Properties ​

Properties ​

color ​

• Optional color: ArrayLike<number>

The optional RGB color of the light. Default is white.

Defined in ​

websg.d.ts:245


innerConeAngle ​

• Optional innerConeAngle: number

The optional inner cone angle of the light, for spot lights.

Defined in ​

websg.d.ts:253


intensity ​

• Optional intensity: number

The optional intensity of the light. Default is 1.

Defined in ​

websg.d.ts:241


name ​

• Optional name: string

The optional name of the light.

Defined in ​

websg.d.ts:237


outerConeAngle ​

• Optional outerConeAngle: number

The optional outer cone angle of the light, for spot lights.

Defined in ​

websg.d.ts:257


range ​

• Optional range: number

The optional range of the light, for point and spot lights.

Defined in ​

websg.d.ts:249


type ​

• type: LightType

The type of the light.

Defined in ​

websg.d.ts:233