Class ScreenSpaceReflection

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

Inheritance

object

Object

ScriptableObject

VolumeComponent

VolumeComponentWithQuality

ScreenSpaceReflection

Implements

IApplyRevertPropertyContextMenuItemProvider

Inherited Members

VolumeComponentWithQuality.quality

VolumeComponentWithQuality.UsesQualitySettings()

VolumeComponent.active

VolumeComponent.displayName

VolumeComponent.parameters

VolumeComponent.OnEnable()

VolumeComponent.OnDisable()

VolumeComponent.Override(VolumeComponent, float)

VolumeComponent.SetAllOverridesTo(bool)

VolumeComponent.GetHashCode()

VolumeComponent.AnyPropertiesIsOverridden()

VolumeComponent.OnDestroy()

VolumeComponent.Release()

VolumeComponent.TryGetRevertMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceTerm()

VolumeComponent.TryGetApplyMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceName(Component)

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Rendering.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

[Serializable]
[VolumeComponentMenu("Lighting/Screen Space Reflection")]
[SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
public class ScreenSpaceReflection : VolumeComponentWithQuality, IApplyRevertPropertyContextMenuItemProvider

Fields

Name	Description
accumulationFactor	Controls the amount of accumulation (0 no accumulation, 1 just accumulate)
ambientProbeDimmer	Controls the dimmer applied to the ambient and legacy light probes.
biasFactor	For PBR: Controls the bias of accumulation (0 no bias, 1 bias ssr)
bounceCount	Number of bounces for reflection rays.
depthBufferThickness	Controls the distance at which HDRP fades out SSR near the edge of the screen.
enableWorldSpeedRejection	When enabled, world space speed from Motion vector is used to reject samples.
enabled	Enable Screen Space Reflections.
enabledTransparent	Enable Transparent Screen Space Reflections.
lastBounceFallbackHierarchy	Controls the fallback hierarchy for lighting the last bounce.
layerMask	Layer mask used to include the objects for screen space reflection.
mode	Controls which version of the effect should be used.
rayMiss	Controls which sources are used to fallback on when the traced ray misses.
reflectSky	When enabled, SSR handles sky reflection for opaque objects (not supported for SSR on transparent).
sampleCount	Number of samples for reflections.
screenFadeDistance	Controls the typical thickness of objects the reflection rays may pass behind.
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.
speedRejectionScalerFactor	Controls the upper range of speed. The faster the objects or camera are moving, the higher this number should be.
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.
speedSurfaceOnly	When enabled, speed rejection used world space motion of the reflecting surface.
speedTargetOnly	When enabled, speed rejection used world space motion of the hit surface by the SSR.
textureLodBias	Defines the LOD Bias for sampling all the textures.
tracing
usedAlgorithm	Screen Space Reflections Algorithm used.

Properties

Name	Description
affectSmoothSurfaces	Controls if the denoising should affect pefectly smooth surfaces
clampValue	Clamps the exposed intensity, this only affects reflections on opaque objects.
denoise	Enable denoising on the ray traced reflections.
denoiserRadius	Controls the radius of reflection denoiser.
fullResolution	Defines if the effect should be evaluated at full resolution.
minSmoothness	Controls the smoothness value at which HDRP activates SSR and the smoothness-controlled fade out stops.
rayLength	Controls the length of reflection rays in meters.
rayMaxIterations	Sets the maximum number of steps HDRP uses for raytracing. Affects both correctness and performance.
rayMaxIterationsRT	Sets the maximum number of steps HDRP uses for mixed tracing. Affects both correctness and performance.
smoothnessFadeStart	Controls the smoothness value at which the smoothness-controlled fade out starts. The fade is in the range [Min Smoothness, Smoothness Fade Start]