Class ScreenSpaceReflections
This class holds settings for the Screen-space Reflections effect.
Inherited Members
Namespace: UnityEngine.Rendering.PostProcessing
Syntax
[Serializable]
public sealed class ScreenSpaceReflections : PostProcessEffectSettingsFields
distanceFade
Fades reflections close to the near plane. This is useful to hide common artifacts.
Declaration
[Range(0F, 1F)]
[Tooltip("Fades reflections close to the near planes.")]
public FloatParameter distanceFadeField Value
| Type | Description |
|---|---|
| FloatParameter |
maximumIterationCount
The maximum number of steps in the raymarching pass. Higher values mean more reflections.
Declaration
[Range(0F, 256F)]
[Tooltip("Maximum number of steps in the raymarching pass. Higher values mean more reflections.")]
public IntParameter maximumIterationCountField 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 maximumMarchDistanceField 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 presetField 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 resolutionField Value
| Type | Description |
|---|---|
| ScreenSpaceReflectionResolutionParameter |
thickness
The ray thickness. Lower values are more expensive but allow the effect to detect smaller details.
Declaration
[Range(1F, 64F)]
[Tooltip("Ray thickness. Lower values are more expensive but allow the effect to detect smaller details.")]
public FloatParameter thicknessField Value
| Type | Description |
|---|---|
| FloatParameter |
vignette
Fades reflections close to the screen edges.
Declaration
[Range(0F, 1F)]
[Tooltip("Fades reflections close to the screen edges.")]
public FloatParameter vignetteField 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 |
|