Class ProbeVolumesOptions

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

Inheritance
object
Object
ScriptableObject
VolumeComponent
ProbeVolumesOptions
Implements
Inherited Members
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance<T>()
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
[Serializable]
[VolumeComponentMenu("Lighting/Probe Volumes Options")]
[SupportedOnRenderPipeline(new Type[] { })]
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 to have the probe considered.

Declaration
[Tooltip("The minimum value that the dot product between the sample position normal and the vector to contributing probe need to have to have the probe considered.")]
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

Extension Methods