Class ProbeVolumesOptions

A volume component that holds settings for the Probe Volumes System per-camera options.

Inheritance

object

Object

ScriptableObject

VolumeComponent

ProbeVolumesOptions

Implements

IApplyRevertPropertyContextMenuItemProvider

Inherited Members

VolumeComponent.active

VolumeComponent.displayName

VolumeComponent.parameters

VolumeComponent.Override(VolumeComponent, float)

VolumeComponent.SetAllOverridesTo(bool)

VolumeComponent.GetHashCode()

VolumeComponent.AnyPropertiesIsOverridden()

VolumeComponent.Release()

VolumeComponent.TryGetRevertMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceTerm()

VolumeComponent.TryGetApplyMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceName(Component)

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Rendering

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

[Serializable]
[VolumeComponentMenuForRenderPipeline("Lighting/Probe Volumes Options (Experimental)", new Type[] { typeof(HDRenderPipeline) })]
public sealed class ProbeVolumesOptions : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider

Fields

animateSamplingNoise

Whether to animate the noise when TAA is enabled, smoothing potentially out the noise pattern introduced.

Declaration

[Tooltip("Whether to animate the noise when TAA is enabled. It can potentially remove the visible noise patterns.")]
public BoolParameter animateSamplingNoise

Field Value

Type	Description
BoolParameter

leakReductionMode

Method used to reduce leaks.

Declaration

[Tooltip("Method used to reduce leaks. Currently available modes are crude, but cheap methods.")]
public APVLeakReductionModeParameter leakReductionMode

Field Value

Type	Description
APVLeakReductionModeParameter

minValidDotProductValue

The minimum value that the dot product between the sample position normal and the vector to contributing probe need to have for the probe to be considered.

Declaration

[Tooltip("Controls how normal based leak reduction is applied. Lower values would consider all probes equally important, while higher ones would favor probes further along the normal direction of the surface.")]
public ClampedFloatParameter minValidDotProductValue

Field Value

Type	Description
ClampedFloatParameter

normalBias

The overridden normal bias to be applied to the world position when sampling the Probe Volumes data structure. Unit is meters.

Declaration

[Tooltip("The overridden normal bias to be applied to the world position when sampling the Probe Volumes data structure. Unit is meters.")]
public ClampedFloatParameter normalBias

Field Value

Type	Description
ClampedFloatParameter

occlusionOnlyReflectionNormalization

When enabled, reflection probe normalization can only decrease the reflections intensity.

Declaration

[Tooltip("When enabled, reflection probe normalization can only decrease the reflection intensity.")]
public BoolParameter occlusionOnlyReflectionNormalization

Field Value

Type	Description
BoolParameter

samplingNoise

Noise to be applied to the sampling position. It can hide seams issues between subdivision levels, but introduces noise.

Declaration

[Tooltip("Noise to be applied to the sampling position. It can hide seams issues between subdivision levels, but introduces noise.")]
public ClampedFloatParameter samplingNoise

Field Value

Type	Description
ClampedFloatParameter

scaleBiasWithMinProbeDistance

Whether to scale the bias for Probe Volumes by the minimum distance between probes.

Declaration

[Tooltip("Whether to scale the bias for Probe Volumes by the minimum distance between probes.")]
public BoolParameter scaleBiasWithMinProbeDistance

Field Value

Type	Description
BoolParameter

viewBias

A bias alongside the view vector to be applied to the world position when sampling the Probe Volumes data structure. Unit is meters.

Declaration

[Tooltip("A bias alongside the view vector to be applied to the world position when sampling the Probe Volumes data structure. Unit is meters.")]
public ClampedFloatParameter viewBias

Field Value

Type	Description
ClampedFloatParameter

Implements

IApplyRevertPropertyContextMenuItemProvider