Class ProbeVolume

A marker to determine what area of the scene is considered by the Probe Volumes system

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
ProbeVolume
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.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-volume-properties", "com.unity.render-pipelines.high-definition")]
[ExecuteAlways]
[AddComponentMenu("Rendering/Probe Volume")]
public class ProbeVolume : MonoBehaviour

Fields

fillEmptySpaces

Whether spaces with no renderers need to be filled with bricks at lowest subdivision level.

Declaration
[HideInInspector]
[Tooltip("Whether Unity should fill empty space between renderers with bricks at the lowest subdivision level.")]
public bool fillEmptySpaces
Field Value
Type Description
bool

globalVolume

If is a global bolume

Declaration
[SerializeField]
[Obsolete("Use mode instead")]
public bool globalVolume
Field Value
Type Description
bool

highestSubdivLevelOverride

The highest subdivision level override

Declaration
[HideInInspector]
public int highestSubdivLevelOverride
Field Value
Type Description
int

lowestSubdivLevelOverride

The lowest subdivision level override

Declaration
[HideInInspector]
public int lowestSubdivLevelOverride
Field Value
Type Description
int

minRendererVolumeSize

The minimum renderer bounding box volume size. This value is used to discard small renderers when the overrideMinRendererVolumeSize is enabled.

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

mode

If is a global bolume

Declaration
[Tooltip("When set to Global this Probe Volume considers all renderers with Contribute Global Illumination enabled. Local only considers renderers in the scene.\nThis list updates every time the Scene is saved or the lighting is baked.")]
public ProbeVolume.Mode mode
Field Value
Type Description
ProbeVolume.Mode

objectLayerMask

The LayerMask

Declaration
public LayerMask objectLayerMask
Field Value
Type Description
LayerMask

overrideRendererFilters

Override the renderer filters.

Declaration
[HideInInspector]
[Min(0)]
public bool overrideRendererFilters
Field Value
Type Description
bool

overridesSubdivLevels

If the subdivision levels need to be overriden

Declaration
[HideInInspector]
public bool overridesSubdivLevels
Field Value
Type Description
bool

size

The size

Declaration
public Vector3 size
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.

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
UnityEngine.Object.GetHashCode()

Extension Methods