Documentation / @ripl/3d / PositionalLightOptions
Interface: PositionalLightOptions ​
Defined in: 3d/src/core/lights.ts:58
Options for a light that radiates from a point.
Extends ​
Extended by ​
Properties ​
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
color? | string | The light's colour. Defaults to '#ffffff'. | LightOptions.color | 3d/src/core/lights.ts:42 |
decay? | number | The exponent of the inverse-distance falloff. Defaults to 2 for physically plausible falloff. | - | 3d/src/core/lights.ts:64 |
distance? | number | The distance at which the light falls to zero. 0 means it never does. Defaults to 0. | - | 3d/src/core/lights.ts:62 |
enabled? | boolean | Whether the light contributes at all. Defaults to true. | LightOptions.enabled | 3d/src/core/lights.ts:46 |
intensity? | number | How strongly the light contributes. Defaults to 1. | LightOptions.intensity | 3d/src/core/lights.ts:44 |
position? | Vector3 | The light's world-space position. Defaults to the origin. | - | 3d/src/core/lights.ts:60 |