Class GlobalIllumination

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

Inheritance

Object

VolumeComponentWithQuality

GlobalIllumination

Inherited Members

VolumeComponentWithQuality.quality

VolumeComponentWithQuality.UsesQualitySettings()

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

public sealed class GlobalIllumination : VolumeComponentWithQuality

Fields

bounceCount

Number of bounces for evaluating the effect.

Declaration

public ClampedIntParameter bounceCount

Field Value

Type	Description
ClampedIntParameter

depthBufferThickness

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

Declaration

public ClampedFloatParameter depthBufferThickness

Field Value

Type	Description
ClampedFloatParameter

enable

Enable screen space global illumination.

Declaration

public BoolParameter enable

Field Value

Type	Description
BoolParameter

layerMask

Defines the layers that GI should include.

Declaration

public LayerMaskParameter layerMask

Field Value

Type	Description
LayerMaskParameter

mode

Controls which version of the effect should be used.

Declaration

public RayTracingModeParameter mode

Field Value

Type	Description
RayTracingModeParameter

rayTracing

Toggles ray traced global illumination.

Declaration

public BoolParameter rayTracing

Field Value

Type	Description
BoolParameter

sampleCount

Number of samples for evaluating the effect.

Declaration

public ClampedIntParameter sampleCount

Field Value

Type	Description
ClampedIntParameter

Properties

clampValue

Controls the clamp of intensity.

Declaration

public float clampValue { get; set; }

Property Value

Type	Description
Single

denoise

Defines if the ray traced global illumination should be denoised.

Declaration

public bool denoise { get; set; }

Property Value

Type	Description
Boolean

denoiserRadius

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

Declaration

public float denoiserRadius { 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

fullResolution

Defines if the effect should be evaluated at full resolution.

Declaration

public bool fullResolution { get; set; }

Property Value

Type	Description
Boolean

fullResolutionSS

Defines if the effect should be evaluated at full resolution.

Declaration

public bool fullResolutionSS { get; set; }

Property Value

Type	Description
Boolean

halfResolutionDenoiser

Defines if the denoiser should be evaluated at half resolution.

Declaration

public bool halfResolutionDenoiser { get; set; }

Property Value

Type	Description
Boolean

rayLength

Controls the length of GI rays.

Declaration

public float rayLength { 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

secondDenoiserPass

Defines if the second denoising pass should be enabled.

Declaration

public bool secondDenoiserPass { get; set; }

Property Value

Type	Description
Boolean

upscaleRadius

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

Declaration

public int upscaleRadius { get; set; }

Property Value

Type	Description
Int32