Struct ScreenSpaceReflectionsSettings

Contains settings for Screen Space Reflections effect rendering.

Assembly: FlaxEngine.dll
File: Engine/Graphics/PostProcessSettings.h
Syntax
public struct ScreenSpaceReflectionsSettings : public ISerializable

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
public float BRDFBias = 0.82f
Field Value
float

DepthResolution

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

Declaration
public ResolutionMode DepthResolution = ResolutionMode::Half
Field Value
ResolutionMode

EdgeFadeFactor

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

Declaration
public float EdgeFadeFactor = 0.1f
Field Value
float

FadeDistance

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

Declaration
public float FadeDistance = 500.0f
Field Value
float

FadeOutDistance

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

Declaration
public float FadeOutDistance = 5000.0f
Field Value
float

Intensity

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

Declaration
public float Intensity = 1.0f
Field Value
float

OverrideFlags

The flags for overriden properties.

Declaration
public ScreenSpaceReflectionsSettingsOverride OverrideFlags = Override::None
Field Value
ScreenSpaceReflectionsSettingsOverride

RayTracePassResolution

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

Declaration
public ResolutionMode RayTracePassResolution = ResolutionMode::Half
Field Value
ResolutionMode

ResolvePassResolution

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

Declaration
public ResolutionMode ResolvePassResolution = ResolutionMode::Full
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
public int32 ResolveSamples = 4
Field Value
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
public float RoughnessThreshold = 0.45f
Field Value
float

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
public bool TemporalEffect = true
Field Value
bool

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
public float TemporalResponse = 0.8f
Field Value
float

TemporalScale

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

Declaration
public float TemporalScale = 8.0f
Field Value
float

TraceMode

The reflections tracing mode.

Declaration
public ReflectionsTraceMode TraceMode = ReflectionsTraceMode::ScreenTracing
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
public bool UseColorBufferMips = true
Field Value
bool

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
public float WorldAntiSelfOcclusionBias = 0.1f
Field Value
float

Methods

BlendWith(ScreenSpaceReflectionsSettings& other, float weight)

Blends the settings using given weight.

Declaration
public void BlendWith(ScreenSpaceReflectionsSettings& other, float weight)
Parameters
ScreenSpaceReflectionsSettings other

The other settings.
float weight

The blend weight.