This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
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
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
Textures
Art Samples
Tutorials

Screen Space Dirt

This section contains settings that control the Screen-Space Dirt effect.

Various slits and cavities are prone to accumulating dirt and dust, while edges tend to wear, scratch and change their initial color, usually this is simulated using so-called curvature maps prepared for each model.

Using this effect allows you to perform curvature mapping (simulate worn scratched edges and accumulation of dirt and dust in cavities) in the screen space for all objects globally. It saves time for large complex scenes with a lot of various models and elements making them look more natural without having to prepare textures for each of them individually.

General Options#

Screen-Space Dirt Settings
Notice
Settings are applied to materials with the Procedural Effects and Dirt states enabled.

The Screen-Space Dirt effect uses additional geometry buffer (Rendering -> Buffers -> Additional Features). If the buffer is disabled, the effect won't be rendered.

Enabled The value indicating if the Screen-Space Dirt (SSDirt) effect is enabled. Enabled by default.
Console access: render_ssdirt

Quality The quality for the SSDirt effect. SSDirt must be enabled. Quality implies the number of samples used for the Screen-Space Dirt effect:
  • Low — 4 samples
  • Medium — 8 samples
  • High — 16 samples
  • Ultra — 32 samples
Notice
This parameter significantly affects performance, so choose it reasonably.
Option #3 is selected by default (see above).
Console access: render_ssdirt_quality
Resolution The resolution of the SSDirt effect. SSDirt must be enabled.
Notice
This parameter significantly affects performance, so choose it reasonably.
One of the following values:
  • Quarter - quarter resolution
  • Half - half resolution (by default)
  • Full - full resolution

Console access: render_ssdirt_resolution
Intensity The intensity of the SSDirt effect.
  • By the minimum value of 0.0f, the effect is not visible.
  • Higher values make the effect more pronounced.
SSDirt must be enabled.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssdirt_intensity

Radius The size of the SSDirt effect. SSDirt must be enabled.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssdirt_radius
Threshold The threshold of the SSDirt effect. It determines depth limit for the SSDirt effect in areas where information cannot be obtained. Higher values make the effect less pronounced. SSDirt must be enabled.
Range of values: [0.0f, 1.0f]. The default value is 1.0f.
Console access: render_ssdirt_threshold
Angle Bias The angle bias value to limit the SSDirt effect where information cannot be obtained. This parameter can be used to remove visual artefacts at the edges of polygons. SSDirt must be enabled.
Notice
This parameter affects both, concave and convex areas.

Range of values: [0.0f, 1.0f]. The default value is 0.35f.
Console access: render_ssdirt_angle_bias
Perspective The perspective value, that determines the degree of impact of distance from the camera on the radius of the Screen-Space Dirt effect.
  • 0.0f - radius of the effect is bound to screen space (it remains constant relative to screen size, regardless of the distance to the camera).
  • 1.0f - radius of the effect is bound to world space (it remains the same relative to objects, i.e. gets smaller as the camera moves away from them).
SSDirt must be enabled.
Range of values: [0.0f, 1.0f]. The default value is 0.02f.
Console access: render_ssdirt_perspective
Increase Accuracy The value indicating if increased accuracy for the SSDirt effect. This option should be used to remove visual artefacts along the screen edges, in case if they appear. Otherwise, it should be disabled. SSDirt must be enabled. Enabled by default.
Console access: render_ssdirt_increase_accuracy

Cavity Options#

These options are used to control the look of pits and other cavity areas where dirt or dust would collect.

Albedo Albedo texture for cavities. This texture defines dirt and dust color pattern for all cavities globally.
Shading Shading texture for cavities. Red channel of this texture defines metalness pattern for all cavities globally (other channels are ignored).
Texture Size The scaling factor for the textures used for cavities. SSDirt must be enabled.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssdirt_cavity_texture_size
Color The color multiplier for the Albedo texture used for cavities (global dirt and dust color pattern). SSDirt must be enabled.
vec4(0.26f, 0.24f, 0.21f, 1.0f) - default value
Console access: render_ssdirt_cavity_color

Exponent The exponent value that determines the rate of gradual change of intensity along the radius for cavities. Lower values make gradual change of intensity smoother. SSDirt must be enabled.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssdirt_cavity_exponent

Metalness The metalness value for cavities. When set to 0 (by default), the SSDirt effect does not modify metalness buffer in cavities. SSDirt must be enabled.
Range of values: [0.0f, 1.0f]. The default value is 0.0f.
Console access: render_ssdirt_cavity_metalness
Metalness Visibility The metalness visibility value for cavities. A multiplier that determines the degree of impact of the effect on metalness buffer (the higher the value the more metalness buffer is affected. SSDirt must be enabled.
Range of values: [0.0f, 1.0f]. The default value is 0.0f.
Console access: render_ssdirt_cavity_metalness_visibility

Convexity Options#

These options are used to control highlighting and accentuating the edges of model (simulating edge wear, scratches or chipped metal.

Albedo Albedo texture for convexities. This texture defines wear and scratch color pattern for all convexities globally.
Shading Shading texture for convexities. Red channel of this texture defines metalness pattern for all convexities globally (other channels are ignored).
Texture Size The scaling factor for the textures used for convexities. SSDirt must be enabled.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssdirt_convexity_texture_size
Color The color multiplier for the Albedo texture used for convexities (global wear and scratch color pattern). SSDirt must be enabled.
vec4(0.48f, 0.44f, 0.39f, 1.0f) - default value
Console access: render_ssdirt_convexity_color
Exponent The exponent value that determines the rate of gradual change of intensity along the radius for convexities. Lower values make gradual change of intensity smoother. SSDirt must be enabled.
Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_ssdirt_convexity_exponent
Metalness The metalness value for convexities. When set to 0 (by default), the SSDirt effect does not modify metalness buffer in convex areas. SSDirt must be enabled.
Range of values: [0.0f, 1.0f]. The default value is 0.0f.
Console access: render_ssdirt_convexity_metalness
Metalness Visibility The metalness visibility value for convexities. A multiplier that determines the degree of impact of the effect on metalness buffer (the higher the value the more metalness buffer is affected. SSDirt must be enabled.
Range of values: [0.0f, 1.0f]. The default value is 0.0f.
Console access: render_ssdirt_convexity_metalness_visibility

Adjusting the SSDirt Effect Per Material#

Despite all major settings of the SSDirt effect are global and are adjusted via the Settings window, some parameters for fine tuning can be set up per material. The SSDirt effect is applied to all materials inherited from the mesh_base and terrain_global_base having the SSDirt option enabled.

To set up SSDirt for a specific material, perform the following:

  1. Enable the Procedural Effects option of the target material.
  2. Enable the SSDirt option of the target material.
  3. Enable the Screen-Space Dirt effect in one of the following ways:
    • Via the Render Settings window: go to the Windows -> Settings -> Runtime -> Render -> SSDirt section and click Enabled.
    • In the Main Menu select Rendering -> Features and choose SSDirt.
  4. In the Render Settings window, specify the global SSDirt settings described above.
  5. In the material settings (the Parameters window), specify cavity and convexity masks in the procedural texture, UV coordinates transformation, Cavity Scale, and Convexity Scale.
Last update: 2021-11-30
Build: ()