Class ScreenSpaceReflection
A volume component that holds settings for screen space reflection and ray traced reflections.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
[Serializable]
[VolumeComponentMenu("Lighting/Screen Space Reflection")]
[SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
public class ScreenSpaceReflection : VolumeComponentWithQuality, IApplyRevertPropertyContextMenuItemProvider
Fields
accumulationFactor
Controls the amount of accumulation (0 no accumulation, 1 just accumulate)
Declaration
public ClampedFloatParameter accumulationFactor
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
ambientProbeDimmer
Controls the dimmer applied to the ambient and legacy light probes.
Declaration
[Tooltip("Controls the dimmer applied to the ambient and legacy light probes.")]
[AdditionalProperty]
public ClampedFloatParameter ambientProbeDimmer
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
biasFactor
For PBR: Controls the bias of accumulation (0 no bias, 1 bias ssr)
Declaration
[AdditionalProperty]
public ClampedFloatParameter biasFactor
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
bounceCount
Number of bounces for reflection rays.
Declaration
public ClampedIntParameter bounceCount
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 |
enabledTransparent
Enable Transparent Screen Space Reflections.
Declaration
[Tooltip("Enable Transparent Screen Space Reflections.")]
public BoolParameter enabledTransparent
Field Value
Type | Description |
---|---|
BoolParameter |
enableWorldSpeedRejection
When enabled, world space speed from Motion vector is used to reject samples.
Declaration
public BoolParameter enableWorldSpeedRejection
Field Value
Type | Description |
---|---|
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 |
---|---|
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 for opaque objects (not supported for SSR on transparent).
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 |
speedRejectionParam
Controls the likelihood history will be rejected based on the previous frame motion vectors of both the surface and the hit object in world space.
Declaration
[AdditionalProperty]
public FloatParameter speedRejectionParam
Field Value
Type | Description |
---|---|
FloatParameter |
speedRejectionScalerFactor
Controls the upper range of speed. The faster the objects or camera are moving, the higher this number should be.
Declaration
[AdditionalProperty]
public ClampedFloatParameter speedRejectionScalerFactor
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
speedSmoothReject
When enabled, history can be partially rejected for moving objects which gives a smoother transition. When disabled, history is either kept or totally rejected.
Declaration
[AdditionalProperty]
public BoolParameter speedSmoothReject
Field Value
Type | Description |
---|---|
BoolParameter |
speedSurfaceOnly
When enabled, speed rejection used world space motion of the reflecting surface.
Declaration
[AdditionalProperty]
public BoolParameter speedSurfaceOnly
Field Value
Type | Description |
---|---|
BoolParameter |
speedTargetOnly
When enabled, speed rejection used world space motion of the hit surface by the SSR.
Declaration
[AdditionalProperty]
public BoolParameter speedTargetOnly
Field Value
Type | Description |
---|---|
BoolParameter |
textureLodBias
Defines the LOD Bias for sampling all the textures.
Declaration
public ClampedIntParameter textureLodBias
Field Value
Type | Description |
---|---|
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, this only affects reflections on opaque objects.
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 in meters.
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 |