This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

SSR

The section contains settings that control screen-space reflections (SSR).

Screen-space reflections settings

Enabled The value indicating if the SSR (Screen Space Reflections) effect is enabled. Disabled by default.
Console access: render_ssr (API control)
Preset The SSR (Screen-Space Reflections) preset used at the moment. To customize the SSR effect options at run time you should activate the Custom preset: One of the following values:
  • Low (by default)
  • Medium
  • High
  • Ultra
  • Extreme
  • Custom

Console access: render_ssr_preset (API control)
Notice
Presets override user-defined custom settings. When any preset other than Custom is active, modification of the parameters via API has no effect. The parameter value set via the last API call shall be used only when the Custom preset is active. When checking the current parameter value via API you'll get the corresponding setting stored in the active preset (default or custom one).

Customizable Settings#

The following settings are available when the Custom preset is selected.

Screen-space reflections custom settings

Screen-Space Reflections Settings
Increased Accuracy The value indicating if increased accuracy option is enabled for the SSR (Screen Space Reflections). This option increases the accuracy of intersection detection between the ray and surfaces, which makes a reflection on smooth surfaces more detailed. Disabled by default.
Console access: render_ssr_increased_accuracy (API control)
Resolution The resolution of SSR (Screen Space Reflections). One of the following values:
  • Quarter - quarter resolution
  • Half - half resolution (by default)
  • Full - full resolution

Console access: render_ssr_resolution (API control)
Resolution Depth The resolution of the depth buffer used for SSR (Screen Space Reflections) calculation. It affects detailing of reflections of tiny objects.
Notice
To gain performance, this option can be set to lower values while enabling increased accuracy.
One of the following values:
  • Quarter - quarter resolution (by default)
  • Half - half resolution
  • Full - full resolution

Console access: render_ssr_resolution_depth (API control)
Resolution Color The resolution of the color buffer used for SSR (Screen Space Reflections) calculation. It significantly affects performance. One of the following values:
  • Quarter - quarter resolution (by default)
  • Half - half resolution
  • Full - full resolution

Console access: render_ssr_resolution_color (API control)
Alpha Accumulation Mode The accumulation mode for Alpha values used when rendering screen-space reflections. Two modes are available:
  • Correct — physically correct implementation.
  • Boosted — artificial implementation that makes SSR more intense and adds additional contrast to some scenes.
Option #2 is selected by default (see above).
Console access: render_ssr_alpha_accumulation_mode (API control)
Num Rays The number of SSR rays per pixel that are used to calculate rough refrections. Using more rays provides more precise SSR roughness calculation, however, it is more expensive.
Range of values: [1, 64]. The default value is 4.
Console access: render_ssr_num_rays (API control)
Num Steps The number of SSR steps per ray that are used for trace calculation. The number of steps defines accuracy of reflections and causes a reasonable performance impact. The higher the value, the more accurate obstacles between objects are accounted.
Range of values: [1, 64]. The default value is 16.
Console access: render_ssr_num_steps (API control)
Step Size The size of the trace step used for SSR calculation. Higher values result in longer traces (however, tiny objects may become missing), lower values produce more detailed reflections of tiny objects.
Range of values: [0.0f, inf]. The default value is 0.5f.
Console access: render_ssr_step_size (API control)
Nonlinear Step Size The linear step size for the SSR effect. At 0.0f, all raymarching steps are of the same size. At 1.0f, each raymarching step is longer than a preceding one, which allows increasing the ray length while keeping the same number of raymarching steps.
Range of values: [0.0f, 1.0f]. The default value is 1.0f.
Console access: render_ssr_non_linear_step_size (API control)
Perspective Compensation The perspective compensation value for the SSR effect. At 0.0f, the raymarching step size doesn't depend on the distance from the reflecting surface to the camera. At 1.0f, the raymarching step size linearly depends on the distance from the reflecting surface to the camera.
Range of values: [0.0f, 1.0f]. The default value is 1.0f.
Console access: render_ssr_perspective_compensation (API control)
Visibility Roughness Min The minimum roughness value, starting from which the SSR (Screen-Space Reflections) effect begins to fade out. It allows reducing noise of reflections on rough materials.
Range of values: [0.0f, 1.0f]. The default value is 1.0f.
Console access: render_ssr_visibility_roughness_min (API control)
Visibility Roughness Max The maximum roughness value, starting from which the SSR (Screen-Space Reflections) effect is not rendered. It allows reducing noise of reflections on rough materials.
Range of values: [0.0f, 1.0f]. The default value is 1.0f.
Console access: render_ssr_visibility_roughness_max (API control)
Roughness Mip Offset The mip offset value for the SSR effect on rough surfaces. Enhances reading a color on rough surfaces on lower-resolution screens. This setting allows reducing the noise and improving performance.
Range of values: [0.0f, 10.0f]. The default value is 4.0f.
Console access: render_ssr_roughness_mip_offset (API control)
Threshold The threshold used for SSR (Screen-Space Reflections) calculation to limit imitation of reflections in areas where SSR cannot get information. Higher values make the effect less pronounced.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssr_threshold (API control)
Threshold Occlusion The value that limits imitation of environment cubemap occlusion in areas where SSR (Screen-Space Reflections) cannot get information. Higher values make the effect less pronounced. This parameter is mainly used for indoor environment to correct false reflections on occluded areas (false reflections are replaced with black color). For outdoor environment, higher values of this parameter are recommended.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssr_threshold_occlusion (API control)
Normal Bias The bias value to which the ray starting position has been shifted along the normal vector. This value is used for SSR (Screen-Space Reflections) calculation. Can be adjusted to fine-tune reflections of small objects at far distances. Recommended for narrow FOV angles. To use this option, SSR should be enabled.
Range of values: [0.0f, 1.0f]. The default value is 1.0f.
Console access: render_ssr_normal_bias (API control)
View Bias The bias value to which the ray starting position has been shifted along the view vector. This value is used for SSR (Screen-Space Reflections) calculation. Can be adjusted to fine-tune reflections of small objects at far distances. Recommended for narrow FOV angles. To use this option, SSR should be enabled.
Range of values: [0.0f, 1.0f]. The default value is 1.0f.
Console access: render_ssr_view_bias (API control)
Color Clamping Intensity The intensity of TAA color clamping at zero pixel velocity for the SSR (Screen-Space Reflections) effect. Lower values result in more accumulated frames combined, which reduces noise flickering, but increases ghosting effect (to reduce ghosting in this case you can use SSR Color Clamping Velocity Threshold), while higher values reduce ghosting effect, but increase flickering.
Range of values: [0.0f, 1.0f]. The default value is 0.0f.
Console access: render_ssr_color_clamping_intensity (API control)
Color Clamping Velocity The sensitivity of TAA color clamping for the SSR (Screen-Space Reflections) effect to pixel velocity change. This parameter is used to reduce ghosting effect for lower Color Clamping Intensity values: it automatically increases clamping intensity for higher velocities, and disables clamping for low velocity values.
Range of values: [0.0f, inf]. The default value is 0.0f.
Console access: render_ssr_color_clamping_velocity_threshold (API control)
Tonemapping Gamma The tonemapping Gamma value for the SSR effect. Helps reducing noise for reflections from bright surfaces. 1.0f corresponds to the physically correct value. The recommended value is 2.0f — although it slightly reduces the reflection brightness, it also significantly reduces noise.
Range of values: [0.0f, 10.0f]. The default value is 2.0f.
Console access: render_ssr_tonemapping_gamma (API control)

Denoise Options#

Denoise The value indicating if noise reduction for the SSR (Screen Space Reflections) effect is enabled.
Notice
Noise reduction is effective only for screen-space reflections on rough surfaces. Reflections on smooth surfaces (Roughness = 0) will not be affected.
Enabled by default.
Console access: render_ssr_denoise (API control)
Radius The radius of the area to be affected by noise reduction for the SSR (Screen-Space Reflections) effect.
Range of values: [1, 3]. The default value is 1.
Console access: render_ssr_denoise_radius (API control)
Quality The noise reduction quality level for the SSR (Screen-Space Reflections) effect defining the number of samples used. Higher values provide better reduction, but for a performance cost (choosing Medium is enough in most cases). One of the following values:
  • Low - low quality
  • Medium - medium quality (by default)
  • High - high quality
  • Ultra - ultra quality

Console access: render_ssr_denoise_quality (API control)
Intensity The noise reduction intensity for the SSR (Screen-Space Reflections) effect. Higher values provide a less noisy, but more blurred result.
Range of values: [0.0f, 1.0f]. The default value is 0.2f.
Console access: render_ssr_denoise_intensity (API control)
Gaussian Sigma The sigma parameter of Gaussian blur used for noise reduction for the SSR (Screen-Space Reflections) effect. This parameter controls the amount of blur applied.
Range of values: [0.0f, 100.0f]. The default value is 10.0f.
Console access: render_ssr_denoise_gaussian_sigma (API control)
Threshold The threshold value for color difference of neighboring pixels used for noise reduction for the SSR (Screen-Space Reflections) effect. Blur is applied when the color difference is less than the threshold value.
Notice
Setting too high values result in blurring the whole image.

Range of values: [0.0f, 1.0f]. The default value is 0.1f.
Console access: render_ssr_denoise_threshold (API control)
Last update: 2022-10-10
Build: ()