Class ScreenSpaceReflection

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

Inheritance

Object

VolumeComponent

VolumeComponentWithQuality

ScreenSpaceReflection

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 class ScreenSpaceReflection : VolumeComponentWithQuality

Fields

bounceCount

Number of bounces for reflection rays.

Declaration

public ClampedIntParameter bounceCount

Field Value

Type	Description
ClampedIntParameter

clampValue

Clamps the exposed intensity.

Declaration

public ClampedFloatParameter clampValue

Field Value

Type	Description
ClampedFloatParameter

denoise

Enable denoising on the ray traced reflections.

Declaration

public BoolParameter denoise

Field Value

Type	Description
BoolParameter

denoiserRadius

Controls the radius of reflection denoiser.

Declaration

public ClampedIntParameter denoiserRadius

Field Value

Type	Description
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
ClampedFloatParameter

enabled

Enable Screen Space Reflections.

Declaration

[Tooltip("Enable Screen Space Reflections.")]
public BoolParameter enabled

Field Value

Type	Description
BoolParameter

fullResolution

Enables full resolution mode.

Declaration

public BoolParameter fullResolution

Field Value

Type	Description
BoolParameter

layerMask

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

Declaration

public LayerMaskParameter layerMask

Field Value

Type	Description
LayerMaskParameter

minSmoothness

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

Declaration

public ClampedFloatParameter minSmoothness

Field Value

Type	Description
ClampedFloatParameter

mode

Controls which version of the effect should be used.

Declaration

public RayTracingModeParameter mode

Field Value

Type	Description
RayTracingModeParameter

rayLength

Controls the length of reflection rays.

Declaration

public ClampedFloatParameter rayLength

Field Value

Type	Description
ClampedFloatParameter

rayTracing

Enable ray traced reflections.

Declaration

public BoolParameter rayTracing

Field Value

Type	Description
BoolParameter

reflectSky

When enabled, SSR handles sky reflection.

Declaration

public BoolParameter reflectSky

Field Value

Type	Description
BoolParameter

sampleCount

Number of samples for reflections.

Declaration

public ClampedIntParameter sampleCount

Field Value

Type	Description
ClampedIntParameter

screenFadeDistance

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

Declaration

public ClampedFloatParameter screenFadeDistance

Field Value

Type	Description
ClampedFloatParameter

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 ClampedFloatParameter smoothnessFadeStart

Field Value

Type	Description
ClampedFloatParameter

upscaleRadius

Controls the size of the upscale radius.

Declaration

public IntParameter upscaleRadius

Field Value

Type	Description
IntParameter

Properties

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