Class GlobalIllumination | High Definition RP | 9.0.0-preview.71
docs.unity3d.com
    Show / Hide Table of Contents

    Class GlobalIllumination

    A volume component that holds settings for the global illumination (screen space and ray traced).

    Inheritance
    Object
    VolumeComponent
    VolumeComponentWithQuality
    GlobalIllumination
    Inherited Members
    VolumeComponentWithQuality.quality
    VolumeComponentWithQuality.UsesQualitySettings()
    VolumeComponent.active
    VolumeComponent.OnEnable()
    VolumeComponent.OnDisable()
    VolumeComponent.Override(VolumeComponent, Single)
    VolumeComponent.SetAllOverridesTo(Boolean)
    VolumeComponent.GetHashCode()
    VolumeComponent.OnDestroy()
    VolumeComponent.Release()
    VolumeComponent.displayName
    VolumeComponent.parameters
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    [Serializable]
    public sealed class GlobalIllumination : VolumeComponentWithQuality

    Fields

    bounceCount

    Number of bounces for evaluating the effect.

    Declaration
    [Tooltip("Number of bounces for GI.")]
    public ClampedIntParameter bounceCount
    Field Value
    Type Description
    ClampedIntParameter

    clampValue

    Controls the clamp of intensity.

    Declaration
    [Tooltip("Controls the clamp of intensity.")]
    public ClampedFloatParameter clampValue
    Field Value
    Type Description
    ClampedFloatParameter

    denoise

    Defines if the ray traced global illumination should be denoised.

    Declaration
    [Tooltip("Denoise the ray-traced GI.")]
    public BoolParameter denoise
    Field Value
    Type Description
    BoolParameter

    denoiserRadius

    Controls the radius of the global illumination denoiser (First Pass).

    Declaration
    [Tooltip("Controls the radius of the GI denoiser (First Pass).")]
    public ClampedFloatParameter denoiserRadius
    Field Value
    Type Description
    ClampedFloatParameter

    depthBufferThickness

    The thickness of the depth buffer value used for the ray marching step

    Declaration
    [Tooltip("Controls the thickness of the depth buffer used for ray marching.")]
    public ClampedFloatParameter depthBufferThickness
    Field Value
    Type Description
    ClampedFloatParameter

    enable

    Enable screen space global illumination.

    Declaration
    [Tooltip("Enable screen space global illumination.")]
    public BoolParameter enable
    Field Value
    Type Description
    BoolParameter

    fullResolution

    Defines if the effect should be evaluated at full resolution.

    Declaration
    [Tooltip("Full Resolution")]
    public BoolParameter fullResolution
    Field Value
    Type Description
    BoolParameter

    halfResolutionDenoiser

    Defines if the denoiser should be evaluated at half resolution.

    Declaration
    [Tooltip("Use a half resolution denoiser.")]
    public BoolParameter halfResolutionDenoiser
    Field Value
    Type Description
    BoolParameter

    layerMask

    Defines the layers that GI should include.

    Declaration
    [Tooltip("Defines the layers that GI should include.")]
    public LayerMaskParameter layerMask
    Field Value
    Type Description
    LayerMaskParameter

    m_ClampValueSS

    Declaration
    [SerializeField]
    public ClampedFloatParameter m_ClampValueSS
    Field Value
    Type Description
    ClampedFloatParameter

    m_FilterRadius

    Declaration
    [Tooltip("Filter Radius")]
    [SerializeField]
    public ClampedIntParameter m_FilterRadius
    Field Value
    Type Description
    ClampedIntParameter

    m_FullResolutionSS

    Declaration
    [SerializeField]
    public BoolParameter m_FullResolutionSS
    Field Value
    Type Description
    BoolParameter

    m_MaximalRadius

    Declaration
    [SerializeField]
    [Tooltip("Controls the maximal world space radius from which we should get indirect lighting contribution.")]
    public ClampedFloatParameter m_MaximalRadius
    Field Value
    Type Description
    ClampedFloatParameter

    m_RaySteps

    Declaration
    [SerializeField]
    [Tooltip("Controls the number of steps used for ray marching.")]
    public ClampedIntParameter m_RaySteps
    Field Value
    Type Description
    ClampedIntParameter

    mode

    Controls which version of the effect should be used.

    Declaration
    [Tooltip("Controls which version of the effect should be used.")]
    public RayTracingModeParameter mode
    Field Value
    Type Description
    RayTracingModeParameter

    rayLength

    Controls the length of GI rays.

    Declaration
    [Tooltip("Controls the length of GI rays.")]
    public ClampedFloatParameter rayLength
    Field Value
    Type Description
    ClampedFloatParameter

    rayTracing

    Toggles ray traced global illumination.

    Declaration
    [Tooltip("Toggles ray traced global illumination.")]
    public BoolParameter rayTracing
    Field Value
    Type Description
    BoolParameter

    sampleCount

    Number of samples for evaluating the effect.

    Declaration
    [Tooltip("Number of samples for GI.")]
    public ClampedIntParameter sampleCount
    Field Value
    Type Description
    ClampedIntParameter

    secondDenoiserPass

    Defines if the second denoising pass should be enabled.

    Declaration
    [Tooltip("Enable second denoising pass.")]
    public BoolParameter secondDenoiserPass
    Field Value
    Type Description
    BoolParameter

    secondDenoiserRadius

    Controls the radius of the global illumination denoiser (Second Pass).

    Declaration
    [Tooltip("Controls the radius of the GI denoiser (Second Pass).")]
    public ClampedFloatParameter secondDenoiserRadius
    Field Value
    Type Description
    ClampedFloatParameter

    upscaleRadius

    Defines what radius value should be used to pre-filter the signal.

    Declaration
    [Tooltip("Upscale Radius")]
    public ClampedIntParameter upscaleRadius
    Field Value
    Type Description
    ClampedIntParameter

    Properties

    clampValueSS

    Defines if the effect should be evaluated at full resolution.

    Declaration
    public float clampValueSS { get; set; }
    Property Value
    Type Description
    Single

    filterRadius

    Defines the radius for the spatial filter

    Declaration
    public int filterRadius { get; set; }
    Property Value
    Type Description
    Int32

    fullResolutionSS

    Defines if the effect should be evaluated at full resolution.

    Declaration
    public bool fullResolutionSS { get; set; }
    Property Value
    Type Description
    Boolean

    maximalRadius

    The maximal world space radius from which we should get indirect lighting contribution.

    Declaration
    public float maximalRadius { get; set; }
    Property Value
    Type Description
    Single

    raySteps

    The number of steps that should be used during the ray marching pass.

    Declaration
    public int raySteps { get; set; }
    Property Value
    Type Description
    Int32
    Back to top
    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