docs.unity3d.com
    Show / Hide Table of Contents

    Class PathTracing

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

    Inheritance
    Object
    VolumeComponent
    PathTracing
    Inherited Members
    VolumeComponent.active
    VolumeComponent.OnEnable()
    VolumeComponent.OnDisable()
    VolumeComponent.Override(VolumeComponent, Single)
    VolumeComponent.SetAllOverridesTo(Boolean)
    VolumeComponent.GetHashCode()
    VolumeComponent.AnyPropertiesIsOverridden()
    VolumeComponent.OnDestroy()
    VolumeComponent.Release()
    VolumeComponent.displayName
    VolumeComponent.parameters
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    [Serializable]
    [VolumeComponentMenuForRenderPipeline("Ray Tracing/Path Tracing (Preview)", new Type[]{typeof(HDRenderPipeline)})]
    public sealed class PathTracing : VolumeComponent

    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, 10].

    Declaration
    [Tooltip("Defines the maximum number of bounces for each path, in [minimumDepth, 10].")]
    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 against 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, 10].

    Declaration
    [Tooltip("Defines the minimum number of bounces for each path, in [1, 10].")]
    public ClampedIntParameter minimumDepth
    Field Value
    Type Description
    ClampedIntParameter

    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
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023