Class ScreenSpaceReflectionsSettings

Contains settings for Screen Space Reflections effect rendering.

System.Object
ScreenSpaceReflectionsSettings
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class ScreenSpaceReflectionsSettings : ValueType

Fields

BRDFBias

The reflection spread parameter. This value controls source roughness effect on reflections blur. Smaller values produce wider reflections spread but also introduce more noise. Higher values provide more mirror-like reflections.

Declaration
[Limit(0F, 1F, 0.01F)]
[EditorOrder(10)]
[EditorDisplay(null, "BRDF Bias")]
public float BRDFBias
Field Value
System.Single

DepthResolution

The depth buffer downscale option to optimize raycast performance. Full gives better quality, but half improves performance.

Declaration
[EditorOrder(2)]
public ResolutionMode DepthResolution
Field Value
ResolutionMode

EdgeFadeFactor

The point at which the far edges of the reflection begin to fade. Has no effect on performance.

Declaration
[Limit(0F, 1F, 0.02F)]
[EditorOrder(30)]
public float EdgeFadeFactor
Field Value
System.Single

FadeDistance

The effect fade distance (in world units). Defines the size of the effect fade from fully visible to fully invisible at FadeOutDistance.

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorOrder(32)]
public float FadeDistance
Field Value
System.Single

FadeOutDistance

The effect fade out end distance from camera (in world units).

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorOrder(31)]
public float FadeOutDistance
Field Value
System.Single

Intensity

The effect intensity (normalized to range [0;1]). Use 0 to disable it.

Declaration
[Limit(0F, 5F, 0.01F)]
[EditorOrder(0)]
public float Intensity
Field Value
System.Single

RayTracePassResolution

The raycast resolution. Full gives better quality, but half improves performance.

Declaration
[EditorOrder(3)]
public ResolutionMode RayTracePassResolution
Field Value
ResolutionMode

ResolvePassResolution

The raycast resolution. Full gives better quality, but half improves performance.

Declaration
[EditorOrder(25)]
public ResolutionMode ResolvePassResolution
Field Value
ResolutionMode

ResolveSamples

The number of rays used to resolve the reflection color. Higher values provide better quality but reduce effect performance. Use value of 1 for the best performance at cost of quality.

Declaration
[Limit(1F, 8F, 1F)]
[EditorOrder(26)]
public int ResolveSamples
Field Value
System.Int32

RoughnessThreshold

The maximum amount of roughness a material must have to reflect the scene. For example, if this value is set to 0.4, only materials with a roughness value of 0.4 or below reflect the scene.

Declaration
[Limit(0F, 1F, 0.01F)]
[EditorOrder(15)]
public float RoughnessThreshold
Field Value
System.Single

TemporalEffect

If checked, enables the temporal pass. Reduces noise, but produces an animated "jittering" effect that's sometimes noticeable. If disabled, the properties below have no effect.

Declaration
[EditorOrder(50)]
[EditorDisplay(null, "Enable Temporal Effect")]
public bool TemporalEffect
Field Value
System.Boolean

TemporalResponse

Defines how quickly reflections blend between the reflection in the current frame and the history buffer. Lower values produce reflections faster, but with more jittering. If the camera in your game doesn't move much, we recommend values closer to 1.

Declaration
[Limit(0.05F, 1F, 0.01F)]
[EditorOrder(60)]
public float TemporalResponse
Field Value
System.Single

TemporalScale

The intensity of the temporal effect. Lower values produce reflections faster, but more noise.

Declaration
[Limit(0F, 20F, 0.5F)]
[EditorOrder(55)]
public float TemporalScale
Field Value
System.Single

TraceMode

The reflections tracing mode.

Declaration
[EditorOrder(1)]
public ReflectionsTraceMode TraceMode
Field Value
ReflectionsTraceMode

UseColorBufferMips

"The input color buffer downscale mode that uses blurred mipmaps when resolving the reflection color. Produces more realistic results by blurring distant parts of reflections in rough (low-gloss) materials. It also improves performance on most platforms but uses more memory.

Declaration
[EditorOrder(40)]
[EditorDisplay(null, "Use Color Buffer Mips")]
public bool UseColorBufferMips
Field Value
System.Boolean

WorldAntiSelfOcclusionBias

The offset of the raycast origin. Lower values produce more correct reflection placement, but produce more artifacts. We recommend values of 0.3 or lower.

Declaration
[Limit(0F, 10F, 0.01F)]
[EditorOrder(20)]
public float WorldAntiSelfOcclusionBias
Field Value
System.Single

Properties

Default

The default ScreenSpaceReflectionsSettings.

Declaration
public static ScreenSpaceReflectionsSettings Default { get; }
Property Value
ScreenSpaceReflectionsSettings

Extension Methods