Class PathTracing
A volume component that holds settings for the Path Tracing effect.
Implements
Inherited Members
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
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 |