Class ProbeAdjustmentVolume
A marker to adjust probes in an area of the scene.
Implements
Inherited Members
Namespace: UnityEngine .Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
[CoreRPHelpURL("probevolumes-adjustment-volume-component-reference", "com.unity.render-pipelines.high-definition")]
[ExecuteAlways]
[AddComponentMenu("Rendering/Probe Adjustment Volume")]
public class ProbeAdjustmentVolume : MonoBehaviour, ISerializationCallbackReceiver
Fields
directSampleCount
Number of samples for direct lighting computations.
Declaration
[Tooltip("Number of samples for direct lighting computations.")]
public int directSampleCount
Field Value
Type | Description |
---|---|
int |
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 |
indirectSampleCount
Number of samples for indirect lighting computations. This includes environment samples.
Declaration
[Tooltip("Number of samples for indirect lighting computations. This includes environment samples.")]
public int indirectSampleCount
Field Value
Type | Description |
---|---|
int |
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 |
maxBounces
Maximum number of bounces for indirect lighting.
Declaration
[Min(0)]
[Tooltip("Maximum number of bounces for indirect lighting.")]
public int maxBounces
Field Value
Type | Description |
---|---|
int |
mode
Choose what to do with probes falling inside this volume
Declaration
public ProbeAdjustmentVolume.Mode mode
Field Value
Type | Description |
---|---|
Probe |
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 |
renderingLayerMask
Rendering layer mask used for the combine operation with the probes inside the volume.
Declaration
public byte renderingLayerMask
Field Value
Type | Description |
---|---|
byte |
renderingLayerMaskOperation
Rendering Layer Mask operation.
Declaration
public ProbeAdjustmentVolume.RenderingLayerMaskOperation renderingLayerMaskOperation
Field Value
Type | Description |
---|---|
Probe |
sampleCountMultiplier
Multiplier for the number of samples specified above.
Declaration
[Min(0)]
[Tooltip("Multiplier for the number of samples specified above.")]
public int sampleCountMultiplier
Field Value
Type | Description |
---|---|
int |
shape
The shape of the adjustment volume
Declaration
[Tooltip("Select the shape used for this Probe Adjustment Volume.")]
public ProbeAdjustmentVolume.Shape shape
Field Value
Type | Description |
---|---|
Probe |
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 |
skyDirection
The sky direction.
Declaration
[Tooltip("The direction for sampling the ambient probe in worldspace when using the Sky Visibility feature.")]
public Vector3 skyDirection
Field Value
Type | Description |
---|---|
Vector3 |
skyOcclusionMaxBounces
Controls the number of bounces per light path for sky occlusion baking.
Declaration
[Range(0, 5)]
public int skyOcclusionMaxBounces
Field Value
Type | Description |
---|---|
int |
skyOcclusionSampleCount
Controls the number of samples per probe for sky occlusion baking.
Declaration
public int skyOcclusionSampleCount
Field Value
Type | Description |
---|---|
int |
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 |
virtualOffsetThreshold
Virtual Offset validity threshold.
Declaration
[Range(0, 0.95)]
public float virtualOffsetThreshold
Field Value
Type | Description |
---|---|
float |
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 |