SSRSettings

Enumerations

SSRRaymarchingQuality
Values:

  • Low = 0 - Const step raymarching with 8 steps.

  • Medium = 1 - Depth hierarchy raymarching with 32 steps.

  • High = 2 - Depth hierarchy raymarching with 64 steps.

  • Max = 3 - Depth hierarchy raymarching with 128 steps.

SSRRoughnessMode
Values:

  • MipChain = 0 - Rough reflections are simulated using mip chain. I. e. the reflections texture is produced as for perfectly smooth surface, then n-th mip is sampled based on the roughness of the surface it’s applied to.

  • DirectionRandomization = 1 - Rough reflections are simulated by randomizing directions towards which reflections are traced according to roughness. This way allows for phyically plausible reflections production, but costs more and introduces noise.

Classes

SSRSettings : NativeComponent

This component is used to setup SSR (screen space reflections) effect. It can provide realistic reflections of the scene, but is limited by what is visible on the screen. Since the effect can be costly, consider disabling it when you don’t really need it.

To use this component, add the following line to your project file:

require engine.core_components.ssr_settings_component // or require engine.core

Usage example:

let setting = create_render_settings()
get_component(renderSettings) $(var ssr : SSRSettings?) {
    ssr.active = true
}
Properties:

SSRSettings.active: bool
SSRSettings.active =(value: bool)

Active flag. If set to true, SSR will be applied to the result image. Default is false.

Arguments:

  • value : bool

SSRSettings.roughnessMode: SSRRoughnessMode
SSRSettings.roughnessMode =(value: SSRRoughnessMode)

Rough reflection simulation mode. See SSRRoughnessMode enum description for details.

Arguments:
SSRSettings.raymarchingQuality: SSRRaymarchingQuality
SSRSettings.raymarchingQuality =(value: SSRRaymarchingQuality)

Quality of depth buffer raymarching. Affects the number of raymarching steps and the method being used.

Arguments: