This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
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
Animations-Related Classes
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
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

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.

Denoiser Common Settings
#

Denoiser Common Settings

Interleaved The interleaved rendering for the Denoiser. disabled by default.
Console access: render_denoise_interleaved (API control)
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)
Information Lost Depth Threshold The value defining starting from which depth the noise reduction effect is applied to the data in the "information lost" areas. This setting is aimed at reducing noise in areas where the ghosting effect commonly occurs.
Range of values: [0.0f, inf]. The default value is : 0.1f.
Console access: render_denoise_information_lost_depth_threshold (API control)
AO Mask Radius The radius of the Ambient Occlusion Mask (the Distance buffer) that is used to additionally configure the Denoiser parameters. This parameter affects only the Environment Probes with the Raymarching mode enabled.
Range of values: [0.0f, inf]. The default value is : 1.0f.
Console access: render_denoise_ao_mask_radius (API control)
Color Clamping Blur Radius The blur radius for the current frame. The blurred image is further used in color clamping. This setting helps reducing noise in dark indoor areas.
Range of values: [0.0f, 64.0f]. The default value is : 8.0f.
Console access: render_denoise_color_clamping_blur_radius (API control)
Color Clamping Blur Intensity The intensity of using the blurred version of the current frame for color clamping.
Range of values: [0.0f, 1.0f]. The default value is : 0.9f.
Console access: render_denoise_color_clamping_blur_intensity (API control)
Color Clamping Blur Intensity AO The intensity of using the blurred version of the current frame for color clamping in the areas where the Ambient Occlusion mask is black.
Range of values: [0.0f, 1.0f]. The default value is : 0.1f.
Console access: render_denoise_color_clamping_blur_intensity_ao (API control)
Information Lost Fix Flicker The value reducing the intensity of flickering pixels in the information lost areas. An excessive value may cause darkening of the areas behind objects when the camera is moving or when objects are moving in space.
Range of values: [0.0f, 1.0f]. The default value is : 0.75f.
Console access: render_denoise_information_lost_fix_flicker (API control)
Hot Pixels Fix Intensity The value reducing the intensity of flickering pixels in the screen space. Adjusting this value may cause darkening of the global illumination.
Range of values: [0.0f, 1.0f]. The default value is : 0.0f.
Console access: render_denoise_hot_pixels_fix_intensity (API control)
Denoise Mask
Frame Count The number of frames stored to generate the denoise mask.
Range of values: [0.0f, inf]. The default value is : 15.0f.
Console access: render_denoise_denoise_mask_frame_count (API control)
Velocity Threshold The threshold for the velocity intensity value at which the denoise mask becomes white. This parameter is used to remove ghosting and flickering pixels when the camera moves quickly.
Range of values: [0.0f, inf]. The default value is : 0.0f.
Console access: render_denoise_denoise_mask_velocity_threshold (API control)
Information Lost Boost The value controlling the intensity of filling in the information lost areas with the white color and temporally accumulating the the result between frames. This parameter reduces the effect of flickering pixels, but may add a ghosting effect.
Range of values: [0.0f, 1.0f]. The default value is : 0.0f.
Console access: render_denoise_denoise_mask_information_lost_boost (API control)
Bias The threshold value for the brightness delta between frames below which the denoise mask becomes black. Denoise mask is based on the difference in brightness between the previous frame and the current one. Sometimes this difference is very small and can be neglected. This bias value is the threshold difference below which the denoise mask will be plain black. Since a zero value may cause a slight blur effect on the global illumination, this bias was added to avoid such effect.
Range of values: [0.0f, inf]. The default value is : 0.001f.
Console access: render_denoise_denoise_mask_bias (API control)
Denoise Threshold The threshold for the pixel brightness delta value of neighboring pixels, which defines if the pixels may be blurred together.
Range of values: [0.0f, inf]. The default value is : 0.05f.
Console access: render_denoise_denoise_mask_denoise_threshold (API control)

Indirect Diffuse Temporal Filtering
#

Indirect Diffuse Temporal Filtering

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)
Frame Count Min The number of accumulated frames in the information lost areas and if the Frames Clamping Velocity value (see the IndirectDiffuseTemporalFilteringFramesClampingVelocityThreshold) is exceeded.
Range of values: [0.0f, inf]. The default value is : 50.0f.
Console access: render_indirect_diffuse_temporal_filtering_frame_count_min (API control)
Frames Clamping Velocity The threshold velocity value exceeding which the number of accumulated frames will be equal to Frame Count Min (see the IndirectDiffuseTemporalFilteringFrameCountMin).
Range of values: [0.0f, inf]. The default value is : 10.0f.
Console access: render_indirect_diffuse_temporal_filtering_frames_clamping_velocity_threshold (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 (see the IndirectDiffuseTemporalFilteringColorClampingVelocityThreshold), 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)
Intensity In AO The intensity of temporal filtering color clamping at zero pixel velocity for Indirect Diffuse in the areas where the Ambient Occlusion mask is black (the Distance buffer).
Range of values: [0.0f, 1.0f]. The default value is : 1.0f.
Console access: render_indirect_diffuse_temporal_filtering_color_clamping_intensity_ao (API control)
By 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 (see the IndirectDiffuseTemporalFilteringColorClampingIntensity) 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
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)
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)
Threshold In AO The threshold of the noise reduction value for the indirect diffuse lighting in the areas where the Ambient Occlusion mask is black.
Range of values: [0.0f, 1.0f]. The default value is : 0.1f.
Console access: render_indirect_diffuse_denoise_threshold_ao (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)

Indirect Specular Temporal Filtering
#

Indirect Specular Temporal Filtering

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)
Frame Count Min The number of accumulated frames in the information lost areas and if the Frames Clamping Velocity value (see the IndirectSpecularTemporalFilteringFramesClampingVelocityThreshold) is exceeded.
Range of values: [0.0f, inf]. The default value is : 50.0f.
Console access: render_indirect_specular_temporal_filtering_frame_count_min (API control)
Frames Clamping Velocity The threshold velocity value exceeding which the number of accumulated frames will be equal to Frame Count Min (see the IndirectSpecularTemporalFilteringFrameCountMin).
Range of values: [0.0f, inf]. The default value is : 10.0f.
Console access: render_indirect_specular_temporal_filtering_frames_clamping_velocity_threshold (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 (see the IndirectSpecularTemporalFilteringColorClampingVelocityThreshold), 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)
Intensity In AO The intensity of temporal filtering color clamping at zero pixel velocity for Indirect Specular in the areas where the Ambient Occlusion mask is black (the Distance buffer).
Range of values: [0.0f, 1.0f]. The default value is : 1.0f.
Console access: render_indirect_specular_temporal_filtering_color_clamping_intensity_ao (API control)
By 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 (see the IndirectSpecularTemporalFilteringColorClampingIntensity) 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 Diffuse Denoiser
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)
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)
Threshold In AO The threshold noise reduction value for the indirect specular lighting in the areas where the Ambient Occlusion mask is black.
Range of values: [0.0f, 1.0f]. The default value is : 0.1f.
Console access: render_indirect_specular_denoise_threshold_ao (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)
Last update: 2023-11-30
Build: ()