Class EnvironmentProbe

Environment Probe can capture space around the objects to provide reflections.

System.Object
Object
SceneObject
Actor
EnvironmentProbe
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[ActorContextMenu("New/Visuals/Environment Probe")]
[ActorToolbox("Visuals")]
[Unmanaged]
public class EnvironmentProbe : Actor, ISerializable

Constructors

EnvironmentProbe()

Initializes a new instance of the EnvironmentProbe.

Declaration
public EnvironmentProbe()

Properties

Brightness

The reflections brightness.

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

CaptureNearPlane

The probe capture camera near plane distance.

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

CubemapResolution

The reflections texture resolution.

Declaration
[EditorOrder(0)]
[EditorDisplay("Probe", null)]
[Unmanaged]
public ProbeCubemapResolution CubemapResolution { get; set; }
Property Value
ProbeCubemapResolution

CustomProbe

Gets or sets the custom probe (null if using baked one or none).

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

IsUsingCustomProbe

True if probe is using custom cube texture (not baked).

Declaration
[Unmanaged]
public bool IsUsingCustomProbe { get; }
Property Value
System.Boolean

Probe

Gets the probe texture used during rendering (baked or custom one).

Declaration
[Unmanaged]
public GPUTexture Probe { get; }
Property Value
GPUTexture

Radius

Gets or sets the probe radius.

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

ScaledRadius

Gets probe scaled radius.

Declaration
[Unmanaged]
public float ScaledRadius { get; }
Property Value
System.Single

UpdateMode

The probe update mode.

Declaration
[EditorOrder(30)]
[EditorDisplay("Probe", null)]
[Unmanaged]
public EnvironmentProbe.ProbeUpdateMode UpdateMode { get; set; }
Property Value
EnvironmentProbe.ProbeUpdateMode

Methods

Bake(Single)

Bakes that probe. It won't be performed now but on async graphics rendering task.

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