This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
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
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.

Denoise

This section contains settings related to Denoise.

Denoise Settings

Preset The Denoise preset used at the moment. Sharpest to Smoothest — intensity of applying the noise reduction temporal filter (smoother settings cause more ghosting, but provide a more credible and smooth effect in static scenes). Low to High — quality of blur processing in denoiser (higher values are more performance-consuming). To customize the Denoise effect options at run time, activate the Custom preset. One of the following values:
  • Disabled (by default)
  • Sharpest Low
  • Sharpest High
  • Sharp Low
  • Sharp High
  • Smooth Low
  • Smooth High
  • Smoothest Low
  • Smoothest High
  • Custom

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

Denoise custom settings

Global Illumination Denoise Settings

Indirect Diffuse Settings#

Indirect Diffuse Temporal Filtering The value indicating if temporal filtering for Indirect Diffuse is enabled. Temporal filtering reduces flickering of indirect diffuse light. enabled by default.
Console access: render_indirect_diffuse_temporal_filtering_enabled (API control)
Frame Count The frame count of temporal filtering for the indirect diffuse effect. Specifies the number of frames for the velocity buffer. The higher the value, the more frames are combined into the final image and the better anti-aliasing.
Range of values: [0.0f, inf]. The default value is 50.0f.
Console access: render_indirect_diffuse_temporal_filtering_frame_count (API control)
Color Clamping Intensity The intensity of temporal filtering color clamping at zero pixel velocity for Indirect Diffuse. 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 Indirect Diffuse 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_indirect_diffuse_temporal_filtering_color_clamping_intensity (API control)
Color Clamping Velocity The sensitivity of temporal filtering color clamping for Indirect Diffuse 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 100.0f.
Console access: render_indirect_diffuse_temporal_filtering_color_clamping_velocity_threshold (API control)
Indirect Diffuse Denoiser The value indicating if noise reduction for Indirect Diffuse is enabled. enabled by default.
Console access: render_indirect_diffuse_denoise_enabled (API control)
Use Denoise Mask The value indicating if the denoise mask for Indirect Diffuse is enabled.This mask identifies which portions of the screen should be denoised more, and which — less. This may ensure more detailed ambient lighting. enabled by default.
Console access: render_indirect_diffuse_denoise_mask_enabled (API control)
Threshold The threshold value for color difference of neighboring pixels used for noise reduction for Indirect Diffuse. 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 1.0f.
Console access: render_indirect_diffuse_denoise_threshold (API control)

Indirect Specular Settings#

Indirect Specular Temporal Filtering The value indicating if temporal filtering for Indirect Specular is enabled. Temporal filtering reduces flickering of Indirect Specular lighting. enabled by default.
Console access: render_indirect_specular_temporal_filtering_enabled (API control)
Frame Count The frame count of temporal filtering for Indirect Specular. Specifies the number of frames for the velocity buffer. The higher the value, the more frames are combined into the final image and the better anti-aliasing.
Range of values: [0.0f, inf]. The default value is 50.0f.
Console access: render_indirect_specular_temporal_filtering_frame_count (API control)
Color Clamping Intensity The intensity of temporal filtering color clamping at zero pixel velocity for Indirect Specular. 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 Indirect Specular Temporal Filtering 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_indirect_specular_temporal_filtering_color_clamping_intensity (API control)
Color Clamping Velocity The sensitivity of temporal filtering color clamping for Indirect Specular 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 100.0f.
Console access: render_indirect_specular_temporal_filtering_color_clamping_velocity_threshold (API control)
Indirect Specular Denoiser The value indicating if noise reduction for Indirect Specular is enabled. enabled by default.
Console access: render_indirect_specular_denoise_enabled (API control)
Use Denoise Mask The value indicating if the denoise mask for Indirect Specular is enabled.This mask identifies which portions of the screen should be denoised more, and which — less. This may ensure more detailed ambient lighting. enabled by default.
Console access: render_indirect_specular_denoise_mask_enabled (API control)
Threshold The threshold value for color difference of neighboring pixels used for noise reduction for the Indirect Specular effect. 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 1.0f.
Console access: render_indirect_specular_denoise_threshold (API control)

Denoiser Common Settings#

Blur Iterations The number of iterations performed for blurring. Higher values increase the blur radius, which helps to reduce noise even in areas with very intense noise. However this greatly affects performance. Recommended values are in range [3, 5].
Range of values: [0, 10]. The default value is 5.
Console access: render_denoise_num_blur_iterations (API control)
Radius The radius of each blur iteration in noise reduction. This value allows simulating a higher number of blur iterations without affecting performance. However, this may cause such screen-space artefact as insufficiently smooth denoiser blur.
Range of values: [1, 3]. The default value is 1.
Console access: render_denoise_radius (API control)
Denoise By Velocity Threshold The velocity threshold for objects moving in the screen, exceeding which the denoiser blur intensity increases. This setting helps reduce noise and ghosting at high-speed movement.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_denoise_denoise_by_velocity_threshold (API control)
Last update: 2023-06-23
Build: ()