Class GlobalIllumination | High Definition RP | 8.3.1
docs.unity3d.com
    Show / Hide Table of Contents

    Class GlobalIllumination

    A volume component that holds settings for the ray traced global illumination.

    Inheritance
    Object
    GlobalIllumination
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    [Serializable]
    public sealed class GlobalIllumination : VolumeComponent

    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

    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

    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

    Enable ray traced global illumination.

    Declaration
    [Tooltip("Enable 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
    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