Hierarchy

  • PBLightSource

Properties

active?: boolean

default = true, whether the lightSource is active or not.

color?: PBColor3

default = white, the tint of the light, in RGB format where each component is a floating point value with a range from 0 to 1.

intensity?: number

default = 16000, light intensity expressed in candels (lumens/m^2 at 1 m distance, or lumens divided by 4*pi)

range?: number

default = -1, how far the light travels, expressed in meters. If negative will be computed automatically as pow(intensity, 0.25)

shadow?: boolean

default = false, whether the light casts shadows or not.

shadowMaskTexture?: TextureUnion

Texture mask through which shadows are cast to simulate caustics, soft shadows, and light shapes such as light entering from a window.

type?: {
    $case: "point";
    point: PBLightSource_Point;
} | {
    $case: "spot";
    spot: PBLightSource_Spot;
}