Class GlobalIllumination
A volume component that holds settings for the global illumination (screen space and ray traced).
Inheritance
GlobalIllumination
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
clampValue
Controls the clamp of intensity.
Declaration
[Tooltip("Controls the clamp of intensity.")]
public ClampedFloatParameter clampValue
Field Value
denoise
Defines if the ray traced global illumination should be denoised.
Declaration
[Tooltip("Denoise the ray-traced GI.")]
public BoolParameter denoise
Field Value
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
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
enable
Enable screen space global illumination.
Declaration
[Tooltip("Enable screen space global illumination.")]
public BoolParameter enable
Field Value
fullResolution
Defines if the effect should be evaluated at full resolution.
Declaration
[Tooltip("Full Resolution")]
public BoolParameter fullResolution
Field Value
halfResolutionDenoiser
Defines if the denoiser should be evaluated at half resolution.
Declaration
[Tooltip("Use a half resolution denoiser.")]
public BoolParameter halfResolutionDenoiser
Field Value
layerMask
Defines the layers that GI should include.
Declaration
[Tooltip("Defines the layers that GI should include.")]
public LayerMaskParameter layerMask
Field Value
m_ClampValueSS
Declaration
[SerializeField]
public ClampedFloatParameter m_ClampValueSS
Field Value
m_FilterRadius
Declaration
[Tooltip("Filter Radius")]
[SerializeField]
public ClampedIntParameter m_FilterRadius
Field Value
m_FullResolutionSS
Declaration
[SerializeField]
public BoolParameter m_FullResolutionSS
Field Value
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
m_RaySteps
Declaration
[SerializeField]
[Tooltip("Controls the number of steps used for ray marching.")]
public ClampedIntParameter m_RaySteps
Field Value
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
rayLength
Controls the length of GI rays.
Declaration
[Tooltip("Controls the length of GI rays.")]
public ClampedFloatParameter rayLength
Field Value
rayTracing
Toggles ray traced global illumination.
Declaration
[Tooltip("Toggles ray traced global illumination.")]
public BoolParameter rayTracing
Field Value
sampleCount
Number of samples for evaluating the effect.
Declaration
[Tooltip("Number of samples for GI.")]
public ClampedIntParameter sampleCount
Field Value
secondDenoiserPass
Defines if the second denoising pass should be enabled.
Declaration
[Tooltip("Enable second denoising pass.")]
public BoolParameter secondDenoiserPass
Field Value
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
upscaleRadius
Defines what radius value should be used to pre-filter the signal.
Declaration
[Tooltip("Upscale Radius")]
public ClampedIntParameter upscaleRadius
Field Value
Properties
clampValueSS
Defines if the effect should be evaluated at full resolution.
Declaration
public float clampValueSS { get; set; }
Property Value
filterRadius
Defines the radius for the spatial filter
Declaration
public int filterRadius { get; set; }
Property Value
fullResolutionSS
Defines if the effect should be evaluated at full resolution.
Declaration
public bool fullResolutionSS { get; set; }
Property Value
maximalRadius
The maximal world space radius from which we should get indirect lighting contribution.
Declaration
public float maximalRadius { get; set; }
Property Value
raySteps
The number of steps that should be used during the ray marching pass.
Declaration
public int raySteps { get; set; }
Property Value
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.