docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class ScreenSpaceReflections

    This class holds settings for the Screen-space Reflections effect.

    Inheritance
    object
    Object
    ScriptableObject
    PostProcessEffectSettings
    ScreenSpaceReflections
    Inherited Members
    PostProcessEffectSettings.active
    PostProcessEffectSettings.enabled
    PostProcessEffectSettings.SetAllOverridesTo(bool, bool)
    PostProcessEffectSettings.GetHash()
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    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.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.Rendering.PostProcessing
    Assembly: Unity.Postprocessing.Runtime.dll
    Syntax
    [Serializable]
    public sealed class ScreenSpaceReflections : PostProcessEffectSettings

    Fields

    distanceFade

    Fades reflections close to the near plane. This is useful to hide common artifacts.

    Declaration
    [Range(0, 1)]
    [Tooltip("Fades reflections close to the near planes.")]
    public FloatParameter distanceFade
    Field Value
    Type Description
    FloatParameter

    maximumIterationCount

    The maximum number of steps in the raymarching pass. Higher values mean more reflections.

    Declaration
    [Range(0, 256)]
    [Tooltip("Maximum number of steps in the raymarching pass. Higher values mean more reflections.")]
    public IntParameter maximumIterationCount
    Field Value
    Type Description
    IntParameter

    maximumMarchDistance

    The maximum distance to traverse in the scene after which it will stop drawing reflections.

    Declaration
    [Tooltip("Maximum distance to traverse after which it will stop drawing reflections.")]
    public FloatParameter maximumMarchDistance
    Field Value
    Type Description
    FloatParameter

    preset

    The quality preset to use for rendering. Use Custom to tweak settings.

    Declaration
    [Tooltip("Choose a quality preset, or use \"Custom\" to create your own custom preset. Don't use a preset higher than \"Medium\" if you desire good performance on consoles.")]
    public ScreenSpaceReflectionPresetParameter preset
    Field Value
    Type Description
    ScreenSpaceReflectionPresetParameter

    resolution

    Changes the size of the internal buffer. Downsample it to maximize performances or supersample it to get slow but higher quality results.

    Declaration
    [Tooltip("Changes the size of the SSR buffer. Downsample it to maximize performances or supersample it for higher quality results with reduced performance.")]
    public ScreenSpaceReflectionResolutionParameter resolution
    Field Value
    Type Description
    ScreenSpaceReflectionResolutionParameter

    thickness

    The ray thickness. Lower values are more expensive but allow the effect to detect smaller details.

    Declaration
    [Range(1, 64)]
    [Tooltip("Ray thickness. Lower values are more expensive but allow the effect to detect smaller details.")]
    public FloatParameter thickness
    Field Value
    Type Description
    FloatParameter

    vignette

    Fades reflections close to the screen edges.

    Declaration
    [Range(0, 1)]
    [Tooltip("Fades reflections close to the screen edges.")]
    public FloatParameter vignette
    Field Value
    Type Description
    FloatParameter

    Methods

    IsEnabledAndSupported(PostProcessRenderContext)

    Returns true if the effect is currently enabled and supported.

    Declaration
    public override bool IsEnabledAndSupported(PostProcessRenderContext context)
    Parameters
    Type Name Description
    PostProcessRenderContext context

    The current post-processing render context

    Returns
    Type Description
    bool

    true if the effect is currently enabled and supported

    Overrides
    PostProcessEffectSettings.IsEnabledAndSupported(PostProcessRenderContext)
    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)