Struct ProbeSettings.Lighting

Lighting parameters for the probe.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Rendering.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

[Serializable]
public struct ProbeSettings.Lighting

Fields

default

Default value.

Declaration

[Obsolete("Since 2019.3, use Lighting.NewDefault() instead.")]
public static readonly ProbeSettings.Lighting @default

Field Value

Type	Description
ProbeSettings.Lighting

fadeDistance

The distance at which reflections smoothly fade out before HDRP cut them completely.

Declaration

public float fadeDistance

Field Value

Type	Description
float

lightLayer

An enum flag to select which Light Layers this Probe interacts with.

Declaration

public RenderingLayerMask lightLayer

Field Value

Type	Description
RenderingLayerMask

multiplier

A multiplier applied to the radiance of the Probe.

Declaration

public float multiplier

Field Value

Type	Description
float

rangeCompressionFactor

The result of the rendering of the probe will be divided by this factor. When the probe is read, this factor is undone as the probe data is read. This is to simply avoid issues with values clamping due to precision of the storing format.

Declaration

[Min(1E-06)]
public float rangeCompressionFactor

Field Value

Type	Description
float

weight

A weight applied to the influence of the Probe.

Declaration

[Range(0, 1)]
public float weight

Field Value

Type	Description
float

Methods

NewDefault()

Default value.

Declaration

public static ProbeSettings.Lighting NewDefault()

Returns

Type	Description
ProbeSettings.Lighting	The default value.