Class SkyLight

Sky light captures the distant parts of the scene and applies it as a light. Allows to add ambient light.

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

Constructors

SkyLight()

Initializes a new instance of the SkyLight.

Declaration
public SkyLight()

Properties

AdditiveColor

Additional color to add. Source texture colors are summed with it. Can be used to apply custom ambient color.

Declaration
[EditorOrder(21)]
[EditorDisplay("Light", null)]
[Unmanaged]
public Color AdditiveColor { get; set; }
Property Value
Color

CustomTexture

The custom texture.

Declaration
[EditorOrder(50)]
[EditorDisplay("Probe", null)]
[Unmanaged]
public CubeTexture CustomTexture { get; set; }
Property Value
CubeTexture

Mode

The current light source mode.

Declaration
[EditorOrder(40)]
[EditorDisplay("Probe", null)]
[Unmanaged]
public SkyLight.Modes Mode { get; set; }
Property Value
SkyLight.Modes

Radius

Gets or sets the radius.

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

SkyDistanceThreshold

Distance from the light at which any geometry should be treated as part of the sky.

Declaration
[EditorOrder(45)]
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorDisplay("Probe", null)]
[Unmanaged]
public float SkyDistanceThreshold { get; set; }
Property Value
System.Single

Methods

Bake(Single)

Bakes that probe.

Declaration
[Unmanaged]
public void Bake(float timeout = 0F)
Parameters
System.Single timeout

The timeout in seconds left to bake it (aka startup time).

Extension Methods