Class ScreenSpaceReflection

A volume component that holds settings for screen space reflection and ray traced reflections.

Inheritance
Object
UnityEngine.Rendering.VolumeComponent
VolumeComponentWithQuality
ScreenSpaceReflection
Inherited Members
UnityEngine.Rendering.VolumeComponent.active
UnityEngine.Rendering.VolumeComponent.OnEnable()
UnityEngine.Rendering.VolumeComponent.OnDisable()
UnityEngine.Rendering.VolumeComponent.Override(UnityEngine.Rendering.VolumeComponent, System.Single)
UnityEngine.Rendering.VolumeComponent.SetAllOverridesTo(System.Boolean)
UnityEngine.Rendering.VolumeComponent.GetHashCode()
UnityEngine.Rendering.VolumeComponent.OnDestroy()
UnityEngine.Rendering.VolumeComponent.Release()
UnityEngine.Rendering.VolumeComponent.displayName
UnityEngine.Rendering.VolumeComponent.parameters
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
[Serializable]
[VolumeComponentMenuForRenderPipeline("Lighting/Screen Space Reflection", new Type[]{typeof(HDRenderPipeline)})]
public class ScreenSpaceReflection : VolumeComponentWithQuality

Fields

accumulationFactor

Controls the amount of accumulation (0 no accumulation, 1 just accumulate)

Declaration
public ClampedFloatParameter accumulationFactor
Field Value
Type Description
UnityEngine.Rendering.ClampedFloatParameter

bounceCount

Number of bounces for reflection rays.

Declaration
public ClampedIntParameter bounceCount
Field Value
Type Description
UnityEngine.Rendering.ClampedIntParameter

depthBufferThickness

Controls the distance at which HDRP fades out SSR near the edge of the screen.

Declaration
public ClampedFloatParameter depthBufferThickness
Field Value
Type Description
UnityEngine.Rendering.ClampedFloatParameter

enabled

Enable Screen Space Reflections.

Declaration
[Tooltip("Enable Screen Space Reflections.")]
public BoolParameter enabled
Field Value
Type Description
UnityEngine.Rendering.BoolParameter

lastBounceFallbackHierarchy

Controls the fallback hierarchy for lighting the last bounce.

Declaration
[AdditionalProperty]
public RayTracingFallbackHierachyParameter lastBounceFallbackHierarchy
Field Value
Type Description
RayTracingFallbackHierachyParameter

layerMask

Layer mask used to include the objects for screen space reflection.

Declaration
public LayerMaskParameter layerMask
Field Value
Type Description
UnityEngine.Rendering.LayerMaskParameter

mode

Controls which version of the effect should be used.

Declaration
public RayTracingModeParameter mode
Field Value
Type Description
RayTracingModeParameter

rayMiss

Controls which sources are used to fallback on when the traced ray misses.

Declaration
[FormerlySerializedAs("fallbackHierachy")]
[AdditionalProperty]
public RayTracingFallbackHierachyParameter rayMiss
Field Value
Type Description
RayTracingFallbackHierachyParameter

reflectSky

When enabled, SSR handles sky reflection.

Declaration
public BoolParameter reflectSky
Field Value
Type Description
UnityEngine.Rendering.BoolParameter

sampleCount

Number of samples for reflections.

Declaration
public ClampedIntParameter sampleCount
Field Value
Type Description
UnityEngine.Rendering.ClampedIntParameter

screenFadeDistance

Controls the typical thickness of objects the reflection rays may pass behind.

Declaration
public ClampedFloatParameter screenFadeDistance
Field Value
Type Description
UnityEngine.Rendering.ClampedFloatParameter

textureLodBias

Defines the LOD Bias for sampling all the textures.

Declaration
public ClampedIntParameter textureLodBias
Field Value
Type Description
UnityEngine.Rendering.ClampedIntParameter

tracing

Declaration
[Tooltip("Controls the casting technique used to evaluate the effect.")]
public RayCastingModeParameter tracing
Field Value
Type Description
RayCastingModeParameter

usedAlgorithm

Screen Space Reflections Algorithm used.

Declaration
public SSRAlgoParameter usedAlgorithm
Field Value
Type Description
SSRAlgoParameter

Properties

affectSmoothSurfaces

Controls if the denoising should affect pefectly smooth surfaces

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

clampValue

Clamps the exposed intensity.

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

denoise

Enable denoising on the ray traced reflections.

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

denoiserRadius

Controls the radius of reflection denoiser.

Declaration
public int denoiserRadius { 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

minSmoothness

Controls the smoothness value at which HDRP activates SSR and the smoothness-controlled fade out stops.

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

rayLength

Controls the length of reflection rays.

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

rayMaxIterations

Sets the maximum number of steps HDRP uses for raytracing. Affects both correctness and performance.

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

rayMaxIterationsRT

Sets the maximum number of steps HDRP uses for mixed tracing. Affects both correctness and performance.

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

smoothnessFadeStart

Controls the smoothness value at which the smoothness-controlled fade out starts. The fade is in the range [Min Smoothness, Smoothness Fade Start]

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