docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class ScreenSpaceReflection

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

    Inheritance
    object
    Object
    ScriptableObject
    VolumeComponent
    VolumeComponentWithQuality
    ScreenSpaceReflection
    Inherited Members
    VolumeComponentWithQuality.quality
    VolumeComponentWithQuality.UsesQualitySettings()
    VolumeComponent.active
    VolumeComponent.OnEnable()
    VolumeComponent.OnDisable()
    VolumeComponent.Override(VolumeComponent, float)
    VolumeComponent.SetAllOverridesTo(bool)
    VolumeComponent.GetHashCode()
    VolumeComponent.OnDestroy()
    VolumeComponent.Release()
    VolumeComponent.displayName
    VolumeComponent.parameters
    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]
    [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
    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

    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

    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.

    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

    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
    bool

    clampValue

    Clamps the exposed intensity, this only affects reflections on opaque objects.

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

    denoise

    Enable denoising on the ray traced reflections.

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

    denoiserRadius

    Controls the radius of reflection denoiser.

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

    fullResolution

    Defines if the effect should be evaluated at full resolution.

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

    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
    float

    rayLength

    Controls the length of reflection rays in meters.

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

    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
    int

    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
    int

    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
    float
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)