Class ScreenSpaceReflections | Post Processing | 2.3.0
docs.unity3d.com
    Show / Hide Table of Contents

    Class ScreenSpaceReflections

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

    Inheritance
    Object
    PostProcessEffectSettings
    ScreenSpaceReflections
    Inherited Members
    PostProcessEffectSettings.active
    PostProcessEffectSettings.enabled
    PostProcessEffectSettings.SetAllOverridesTo(Boolean, Boolean)
    PostProcessEffectSettings.GetHash()
    Namespace: UnityEngine.Rendering.PostProcessing
    Syntax
    [Serializable]
    public sealed class ScreenSpaceReflections : PostProcessEffectSettings

    Fields

    distanceFade

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

    Declaration
    public FloatParameter distanceFade
    Field Value
    Type Description
    FloatParameter

    maximumIterationCount

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

    Declaration
    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
    public FloatParameter maximumMarchDistance
    Field Value
    Type Description
    FloatParameter

    preset

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

    Declaration
    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
    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
    public FloatParameter thickness
    Field Value
    Type Description
    FloatParameter

    vignette

    Fades reflections close to the screen edges.

    Declaration
    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
    Boolean

    true if the effect is currently enabled and supported

    Overrides
    PostProcessEffectSettings.IsEnabledAndSupported(PostProcessRenderContext)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023