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.

Shadows

This section contains settings of scene shadows.

Shadows Settings
Enabled The value indicating whether shadows are rendered. enabled by default.
Console access: render_shadows (API control)
Filter Mode The global filtering mode to be used for shadows from all light sources by default. This mode determines quality of soft shadows. Higher quality produces smoother shadow edges. When disabled, no filtering is performed and the stair-step effect is clearly seen at the edges of shadows.
Notice
You can set filtering mode or disable filtering for each light source individually.
One of the following values:
  • Disabled
  • Low
  • Medium (by default)
  • High
  • Ultra

Console access: render_shadows_filter_mode (API control)

Filter Noise The value indicating if noise for shadow filtering is enabled. This noise is used for smoothing. enabled by default.
Console access: render_shadows_filter_noise (API control)

Penumbra Mode The global quality mode to be used for rendering penumbra from all light sources by default. This mode enables simulation of real-world shadows by keeping sharp contact shadows closer to the base and softening the farther the shadow stretches away. Higher values produce softer shadows. When disabled, shadow edges are crisp and sharp (no shadow softness at all).
Notice
You can set penumbra quality mode or disable penumbra rendering for each light source individually. But these per-light quality settings are ignored when global quality is set to Disabled.
One of the following values:
  • Disabled
  • Low (by default)
  • Medium
  • High
  • Ultra

Console access: render_shadows_penumbra_mode (API control)

Penumbra Noise The value indicating if noise for penumbra rendering is enabled. This noise is used for smoothing. enabled by default.
Console access: render_shadows_penumbra_noise (API control)

Translucent Depth The global translucence depth value defining how deep the light goes through translucent objects shifting the shadow. The higher the value, the deeper the light penetrates translucent objects shifting the shadow.
Range of values: [0.0f, inf]. The default value is 0.1f.
Console access: render_shadows_translucent_depth (API control)
Translucent Depth = 0.06
Translucent Depth = 0.4
Lerp Shadow Cascades The value indicating if linear interpolation of shadow cascades is enabled, making transitions between cascades smoother. This option significantly affects performance, as two shadow maps are rendered in transition areas. enabled by default.
Console access: render_shadows_world_lerp_cascades (API control)
Screen Space Shadows The value indicating if screen space shadows are enabled. They provide high-quality penumbra, per-light work, per-pixel detail at any zoom level and infinite visibility distance (when enabled, distant objects can cast shadows next to the horizon). Supports depth cutout parallax. Screen space shadows can be mixed with regular ones. enabled by default.
Console access: render_shadows_screen_space (API control)
Alpha Test Accounting The value indicating if alpha test is enabled for shadows. enabled by default.
Console access: render_shadows_alpha_test (API control)
Shadow Cascades Culling Clusters The value indicating whether culling of shadow cascades is enabled for Mesh Cluster/Clutter objects. If enabled, the Mesh Cluster/Clutter objects rendered in the nearest cascade won't be rendered again in farther cascades. If disabled, the Mesh Cluster objects rendered in the nearest cascade will also be rendered in all other cascades. In some cases performance may be better if this option is disabled. disabled by default.
Console access: render_shadows_world_cascades_culling_clusters (API control)
Distance The distance from the camera, beyond which shadows will not be rendered.
Notice
If this value is greater than the visibility distance for objects the shadows will still be rendered even though the objects themselves are not. Please, pay attention to setting these parameters properly to avoid wasting performance on rendering unnecessary shadows.

Range of values: [0.0f, inf]. The default value is 100.0f.
Console access: render_shadow_distance (API control)
Shadow distance
Distance = 1200 units
Shadow distance
Distance = 80 units
Distance Scale The global scale multiplier for shadow distances. This option enables you to easily increase or decrease shadows rendering performance by changing the scale.
Notice
If this value is greater than the scale multiplier for objects, the shadows will still be rendered even though the objects themselves are not. Please, make sure you set these parameters properly to avoid wasting performance on rendering unnecessary shadows.

Range of values: [0.0f, inf]. The default value is 1.0f.
Console access: render_shadow_distance_scale (API control)
Last update: 2023-06-23
Build: ()