This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
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
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

SSAO

This section contains settings related to screen-space ambient occlusion (SSAO).

Ambient Occlusion Settings

Enabled The value indicating if the SSAO (Screen Space Ambient Occlusion) effect is enabled. Enabled by default.
Console access: render_ssao (API control)
Preset The SSAO (Screen-Space Ambient Occlusion) preset used at the moment. One of the following values:
  • Simple Low (by default)
  • Simple Medium
  • Simple High
  • Simple Ultra
  • Raytracing
  • Raytracing + Denoise
  • Custom

Console access: render_ssao_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.

SSAO custom settings

Screen-Space Ambient Occlusion Settings
Intensity The intensity of the SSAO (Screen Space Ambient Occlusion) for the scene. The intensity value affects brightness of shadows: by the minimum value of 0.0f, the ambient occlusion shadowing is the lightest.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssao_intensity (API control)
Intensity Lighted Side The intensity of the SSAO (Screen Space Ambient Occlusion) for the scene object's lighted side.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssao_intensity_lighted_side (API control)
Intensity Reflection The intensity of SSAO (Screen Space Ambient Occlusion) on reflections.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssao_intensity_reflection (API control)
Cavity The value indicating if the cavity option for the SSAO (Screen Space Ambient Occlusion) effect is enabled. This option improves (sharpens) the look of junction contours at low resolutions, so it should be used for detail enhancement (small stones, bolts and so on).
Notice
When checking the parameter value via API, you'll get the corresponding setting stored in the active preset (default or custom one).
Enabled by default.
Console access: render_ssao_cavity (API control)
Cavity Intensity The intensity of sharpening of contours for the cavity option.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssao_cavity_intensity (API control)
Cavity Radius The size of junction contours area for the cavity option for the SSAO (Screen Space Ambient Occlusion) effect.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssao_cavity_radius (API control)
Color Clamping Intensity The intensity of TAA color clamping at zero pixel velocity for the SSAO (Screen Space Ambient Occlusion) 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 SSAO Color Clamping Velocity Threshold, while higher values reduce ghosting effect, but increase flickering.
Range of values: [0.0f, 1.0f]. The default value is 1.0f.
Console access: render_ssao_color_clamping_intensity (API control)
Color Clamping Velocity The sensitivity of TAA color clamping for the SSAO (Screen Space Ambient Occlusion) 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_ssao_color_clamping_velocity_threshold (API control)
Ray Tracing The value indicating if ray tracing is used for SSAO (Screen Space Ambient Occlusion) calculation. When enabled, SSAO provides more realistic shadows between the objects.
Notice
Ray-traced SSAO calculation available only when the SSRTGI technique is enabled.
Enabled by default.
Console access: render_ssao_ray_tracing (API control)

The following parameters are available when Ray Tracing option is disabled:

Quality The quality of SSAO (Screen Space Ambient Occlusion). Each quality uses the following number of samples:
  • Low — 4 samples
  • Medium — 8 samples
  • High — 16 samples
  • Ultra — 32 samples
Option #2 is selected by default (see above).
Console access: render_ssao_quality (API control)
Resolution The resolution of SSAO (Screen Space Ambient Occlusion). One of the following values:
  • Quarter - quarter resolution
  • Half - half resolution (by default)
  • Full - full resolution

Console access: render_ssao_resolution (API control)
Noise The value indicating if noise for the SSAO (Screen Space Ambient Occlusion) effect is enabled. This option reduces banding effect.
Notice
It is recommended to use noise with TAA enabled.
Enabled by default.
Console access: render_ssao_noise (API control)
Radius The radius of SSAO (Screen Space Ambient Occlusion). The radius is the distance for each of the points in the world space, up to which they can shadow their neighboring points:
  • By low values, each point can cast shadows only on the points in the close range.
  • By high values, each point casts shadows on points at more distant locations.

Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssao_radius (API control)
SSAO Threshold The threshold value for the SSAO (Screen Space Ambient Occlusion) effect. It limits SSAO in areas where information cannot be obtained. The higher the value, the less pronounced the effect is.
Range of values: [0.0f, 1.0f]. The default value is 0.5f.
Console access: render_ssao_threshold (API control)

Ray Tracing Options#

Ray-Traced Global Illumination Settings

Ray-Traced Global Illumination Settings

These settings are available when the Ray Tracing option is enabled.

Ray Tracing Threshold The threshold value for the ray-traced SSAO (Screen Space Ambient Occlusion). Ray-traced SSAO calculation is available only when the SSRTGI technique is enabled.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssao_ray_tracing_threshold (API control)

Denoise Options#

Denoise The value indicating if noise reduction for the ray-traced SSAO (Screen Space Ambient Occlusion) is enabled. This option reduces noise by using blur effect.
Notice
Ray-traced SSAO calculation is available only when the SSRTGI technique is enabled.
Enabled by default.
Console access: render_ssao_ray_tracing_denoise (API control)

Radius The radius of the area to be affected by noise reduction for the SSAO (Screen Space Ambient Occlusion) effect.
Range of values: [1, 3]. The default value is 1.
Console access: render_ssao_denoise_radius (API control)
Quality The noise reduction quality level for the SSAO (Screen-Space Ambient Occlusion) 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_ssao_denoise_quality (API control)
Intensity The noise reduction intensity for the SSAO (Screen Space Ambient Occlusion) 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_ssao_denoise_intensity (API control)
Gaussian Sigma The sigma parameter of Gaussian blur used for noise reduction for the SSAO (Screen Space Ambient Occlusion) 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_ssao_denoise_gaussian_sigma (API control)
Threshold The threshold.threshold value for color difference of neighboring pixels used for noise reduction for the SSAO (Screen Space Ambient Occlusion) effect. The blur is applied when the color difference is less than the threshold value.
Notice
Setting too high values results in blurring the whole image.

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