Class ProbeTouchupVolume

A marker to adjust probes in an area of the scene.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
ProbeTouchupVolume
Implements
Inherited Members
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Object.GetHashCode()
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
[CoreRPHelpURL("probevolumes-settings#probe-adjustment-volume", "com.unity.render-pipelines.high-definition")]
[ExecuteAlways]
[AddComponentMenu("Rendering/Probe Adjustment Volume")]
public class ProbeTouchupVolume : MonoBehaviour, ISerializationCallbackReceiver

Fields

geometryBias

Determines how far Unity pushes a probe out of geometry after a ray hit.

Declaration
[Range(0, 1)]
[Tooltip("Determines how far Unity pushes a probe out of geometry after a ray hit.")]
public float geometryBias
Field Value
Type Description
float

intensityScale

A scale to apply to probes falling within the invalidation volume. It is really important to use this with caution as it can lead to inconsistent lighting.

Declaration
[Range(0.0001, 2)]
[Tooltip("A multiplier applied to the intensity of probes covered by this Probe Adjustment Volume.")]
public float intensityScale
Field Value
Type Description
float

invalidateProbes

Whether to invalidate all probes falling within this volume.

Declaration
[Obsolete("Use mode")]
public bool invalidateProbes
Field Value
Type Description
bool

mode

Choose what to do with probes falling inside this volume

Declaration
public ProbeTouchupVolume.Mode mode
Field Value
Type Description
ProbeTouchupVolume.Mode

overriddenDilationThreshold

The overridden dilation threshold.

Declaration
[Range(0, 0.95)]
public float overriddenDilationThreshold
Field Value
Type Description
float

overrideDilationThreshold

Whether to use a custom threshold for dilation for probes falling withing this volume.

Declaration
[Obsolete("Use mode")]
public bool overrideDilationThreshold
Field Value
Type Description
bool

radius

The size for sphere shape.

Declaration
[Min(0)]
[Tooltip("Modify the radius of this Probe Adjustment Volume. This is unaffected by the GameObject's Transform's Scale property.")]
public float radius
Field Value
Type Description
float

rayOriginBias

Distance from the probe position used to determine the origin of the sampling ray.

Declaration
[Range(-0.05, 0)]
[Tooltip("Distance from the probe position used to determine the origin of the sampling ray.")]
public float rayOriginBias
Field Value
Type Description
float

shape

The shape of the adjustment volume

Declaration
[Tooltip("Select the shape used for this Probe Adjustment Volume.")]
public ProbeTouchupVolume.Shape shape
Field Value
Type Description
ProbeTouchupVolume.Shape

size

The size for box shape.

Declaration
[Min(0)]
[Tooltip("Modify the size of this Probe Adjustment Volume. This is unaffected by the GameObject's Transform's Scale property.")]
public Vector3 size
Field Value
Type Description
Vector3

virtualOffsetDistance

Determines how far probes are pushed along the specified virtual offset direction.

Declaration
[Min(0)]
public float virtualOffsetDistance
Field Value
Type Description
float

virtualOffsetRotation

The rotation angles for the virtual offset direction.

Declaration
public Vector3 virtualOffsetRotation
Field Value
Type Description
Vector3

Methods

GetExtents()

Returns the extents of the volume.

Declaration
public Vector3 GetExtents()
Returns
Type Description
Vector3

The extents of the ProbeVolume.

Implements

Extension Methods