Class SpotLight

Spot light emits light from the point in a given direction.

System.Object
Object
SceneObject
Actor
Light
LightWithShadow
SpotLight
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[ActorContextMenu("New/Lights/Spot Light")]
[ActorToolbox("Lights")]
[Unmanaged]
public class SpotLight : LightWithShadow, ISerializable

Constructors

SpotLight()

Initializes a new instance of the SpotLight.

Declaration
public SpotLight()

Properties

FallOffExponent

Controls the radial falloff of light when UseInverseSquaredFalloff is disabled.

Declaration
[EditorOrder(14)]
[EditorDisplay("Light", null)]
[Limit(2F, 16F, 0.01F)]
[VisibleIf("UseInverseSquaredFalloff", true)]
[Unmanaged]
public float FallOffExponent { get; set; }
Property Value
System.Single

IESBrightnessScale

Global scale for IES brightness contribution.

Declaration
[EditorOrder(213)]
[Limit(0F, 10000F, 0.01F)]
[EditorDisplay("IES Profile", "Brightness Scale")]
[Unmanaged]
public float IESBrightnessScale { get; set; }
Property Value
System.Single

IESTexture

IES texture (light profiles from real world measured data).

Declaration
[EditorOrder(211)]
[EditorDisplay("IES Profile", "IES Texture")]
[Unmanaged]
public IESProfile IESTexture { get; set; }
Property Value
IESProfile

InnerConeAngle

Sets the spot light's inner cone angle (in degrees).

Declaration
[EditorOrder(21)]
[EditorDisplay("Light", null)]
[Limit(1F, 89F, 0.1F)]
[Unmanaged]
public float InnerConeAngle { get; set; }
Property Value
System.Single

OuterConeAngle

Gets or sets the spot light's outer cone angle (in degrees).

Declaration
[EditorOrder(22)]
[EditorDisplay("Light", null)]
[Limit(1F, 89F, 0.1F)]
[Unmanaged]
public float OuterConeAngle { get; set; }
Property Value
System.Single

Radius

Gets or sets light radius.

Declaration
[EditorOrder(1)]
[EditorDisplay("Light", null)]
[Limit(0F, 10000F, 0.1F)]
[Unmanaged]
public float Radius { get; set; }
Property Value
System.Single

SourceRadius

Light source bulb radius.

Declaration
[EditorOrder(2)]
[EditorDisplay("Light", null)]
[Limit(0F, 1000F, 0.01F)]
[Unmanaged]
public float SourceRadius { get; set; }
Property Value
System.Single

UseIESBrightness

Enable/disable using light brightness from IES profile.

Declaration
[EditorOrder(212)]
[EditorDisplay("IES Profile", "Use IES Brightness")]
[Unmanaged]
public bool UseIESBrightness { get; set; }
Property Value
System.Boolean

UseInverseSquaredFalloff

Whether to use physically based inverse squared distance falloff, where Radius is only clamping the light's contribution.

Declaration
[EditorOrder(13)]
[EditorDisplay("Light", null)]
[Unmanaged]
public bool UseInverseSquaredFalloff { get; set; }
Property Value
System.Boolean

Extension Methods