Documentation / @ripl/3d / SpotLightOptions

Interface: SpotLightOptions

Defined in: 3d/src/core/lights.ts:83

Options for SpotLight.

Extends

• PositionalLightOptions.DirectedLightOptions

Properties

Property	Type	Description	Inherited from	Defined in
angle?	number	Half-angle of the cone, in radians, clamped to below a right angle. Defaults to Math.PI / 6.	-	3d/src/core/lights.ts:85
color?	string	The light's colour. Defaults to '#ffffff'.	PositionalLightOptions.color	3d/src/core/lights.ts:42
decay?	number	The exponent of the inverse-distance falloff. Defaults to 2 for physically plausible falloff.	PositionalLightOptions.decay	3d/src/core/lights.ts:64
direction?	Vector3	The direction the light travels in.	DirectedLightOptions.direction	3d/src/core/lights.ts:52
distance?	number	The distance at which the light falls to zero. 0 means it never does. Defaults to 0.	PositionalLightOptions.distance	3d/src/core/lights.ts:62
enabled?	boolean	Whether the light contributes at all. Defaults to true.	PositionalLightOptions.enabled	3d/src/core/lights.ts:46
intensity?	number	How strongly the light contributes. Defaults to 1.	PositionalLightOptions.intensity	3d/src/core/lights.ts:44
penumbra?	number	How softly the cone fades at its edge, from 0 (hard) to 1 (fully soft). Defaults to 0.	-	3d/src/core/lights.ts:87
position?	Vector3	The light's world-space position. Defaults to the origin.	PositionalLightOptions.position	3d/src/core/lights.ts:60
space?	LightSpace	Whether DirectionalLight.direction is fixed in world space or follows the camera. Defaults to 'world'.	DirectedLightOptions.space	3d/src/core/lights.ts:54