Class PathTracing

A volume component that holds settings for the Path Tracing effect.

Inheritance

object

Object

ScriptableObject

VolumeComponent

PathTracing

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, Vector3, Quaternion, CancellationToken)

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

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

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.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

[Serializable]
[VolumeComponentMenu("Ray Tracing/Path Tracing")]
[SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
public sealed class PathTracing : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider

Constructors

PathTracing()

Default constructor for the path tracing volume component.

Declaration

public PathTracing()

Fields

customSeed

Defines the noise index to be used in the custom SeedMode. This value should be set through a script and is ignored in other modes.

Declaration

[HideInInspector]
public IntParameter customSeed

Field Value

Type	Description
IntParameter

enable

Enables path tracing (thus disabling most other passes).

Declaration

[Tooltip("Enables path tracing (thus disabling most other passes).")]
public BoolParameter enable

Field Value

Type	Description
BoolParameter

layerMask

Defines the layers that path tracing should include.

Declaration

[Tooltip("Defines the layers that path tracing should include.")]
public LayerMaskParameter layerMask

Field Value

Type	Description
LayerMaskParameter

maximumDepth

Defines the maximum number of bounces for each path, in [minimumDepth, 32].

Declaration

[Tooltip("Defines the maximum number of bounces for each path, in [minimumDepth, 32].")]
public ClampedIntParameter maximumDepth

Field Value

Type	Description
ClampedIntParameter

maximumIntensity

Defines the maximum, post-exposed luminance computed for indirect path segments.

Declaration

[Tooltip("Defines the maximum, post-exposed luminance computed for indirect path segments. Lower values help prevent noise and fireflies (very bright pixels), but introduce bias by darkening the overall result. Increase this value if your image looks too dark.")]
public MinFloatParameter maximumIntensity

Field Value

Type	Description
MinFloatParameter

maximumSamples

Defines the maximum number of paths cast within each pixel, over time (one per frame).

Declaration

[Tooltip("Defines the maximum number of paths cast within each pixel, over time (one per frame).")]
public ClampedIntParameter maximumSamples

Field Value

Type	Description
ClampedIntParameter

minimumDepth

Defines the minimum number of bounces for each path, in [1, 32].

Declaration

[Tooltip("Defines the minimum number of bounces for each path, in [1, 32].")]
public ClampedIntParameter minimumDepth

Field Value

Type	Description
ClampedIntParameter

seedMode

Defines the mode used to calculate the noise index.

Declaration

[Tooltip("Defines the mode used to calculate the noise index used per path tracing sample.")]
public SeedModeParameter seedMode

Field Value

Type	Description
SeedModeParameter

skyImportanceSampling

Defines if and when sky importance sampling is enabled. It should be turned on for sky models with high contrast and bright spots, and turned off for smooth, uniform skies.

Declaration

[Tooltip("Defines if and when sky importance sampling is enabled. It should be turned on for sky models with high contrast and bright spots, and turned off for smooth, uniform skies.")]
public SkyImportanceSamplingParameter skyImportanceSampling

Field Value

Type	Description
SkyImportanceSamplingParameter

tilingParameters

Defines the number of tiles (X: width, Y: height) and the indices of the current tile (Z: i in [0, width[, W: j in [0, height[) for interleaved tiled rendering.

Declaration

[Tooltip("Defines the number of tiles (X: width, Y: height) and the indices of the current tile (Z: i in [0, width[, W: j in [0, height[) for interleaved tiled rendering.")]
public Vector4Parameter tilingParameters

Field Value

Type	Description
Vector4Parameter

Implements

IApplyRevertPropertyContextMenuItemProvider