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
VR Development
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
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.

Lights

This section contains lights-related settings, such as lens flares effect, batching and interleaved rendering parameters as well as per-object limits for forward rendering pass.

Lights settings

Lights Settings
Deferred Lights The value indicating if rendering of lights is enabled. enabled by default.
Console access: render_lights_enabled (API control)
Lens Flares The value indicating if rendering of per-light lens flares is enabled. enabled by default.
Console access: render_lights_lens_flares (API control)

Batching Options#

Max Per Batch The maximum number of lights rendered by a tile (see the LightsTileGridSize) per batch call.

With lights batching optimization, omni lights divided into tiles are rendered in batches: each tile renders the specified number of lights per batch. It allows decreasing the number of DIP calls and increasing performance. The optimization works only for omni lights with point shape and without shadows.

0 disables batching optimization.


Range of values: [32, 1024]. The default value is : 1024.
Console access: render_lights_max_per_batch (API control)
Tile Grid Size The number of grid tiles per axis for tiled rendering optimization. During this optimization, the screen space is divided into tiles that render lights in batches (see the LightsMaxPerBatch). The optimization works only for omni lights with point shape and without shadows.
Range of values: [1, 32]. The default value is : 8.
Console access: render_lights_tile_grid_size (API control)

Interleaved Rendering Options#

Enabled The
Console access: render_lights_interleaved (API control)
Samples The
(API control)
Color Clamping The
Console access: render_lights_interleaved_color_clamping (API control)
Catmull Resampling The
Console access: render_lights_interleaved_catmull_resampling (API control)

Forward Per-Object Limits#

Ambient The value indicating if the transparent ambient pass is rendered.
Notice
This option takes effect only when the forward rendering pass is used for transparent objects rendering.
enabled by default.
Console access: render_transparent_ambient (API control)
Lights The value indicating if the transparent light pass is rendered.
Notice
This option takes effect only when the forward rendering pass is used for transparent objects rendering.
enabled by default.
Console access: render_transparent_light (API control)
Multiple Environment Probes The value indicating if the transparent multiple environment probes pass is rendered.
Notice
This method takes effect only when the forward rendering pass is used for transparent objects rendering.
enabled by default.
Console access: render_transparent_multiple_env_probes (API control)
World The maximum number of World lights per object (available only for materials rendered in the forward rendering pass). You should set the nonzero value to increase performance: it is not recommended to use more than 4 World lights per object.
Range of values: [0, 128]. The default value is : 4.
Console access: render_lights_forward_per_object_world (API control)
Omni The maximum number of Omni lights per object (available only for materials rendered in the forward rendering pass). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Omni lights per object.
Range of values: [0, 128]. The default value is : 4.
Console access: render_lights_forward_per_object_omni (API control)
Proj The maximum number of Projected lights per object (available only for materials rendered in the forward rendering pass). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Projected lights per object.
Range of values: [0, 128]. The default value is : 4.
Console access: render_lights_forward_per_object_proj (API control)
Environment Probe The maximum number of Environment Probes per object (available only for materials rendered in the forward rendering pass). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Voxel Probes per object.
Range of values: [0, 128]. The default value is : 4.
Console access: render_lights_forward_per_object_env (API control)
Voxel Probe The maximum number of Voxel Probes per object (available only for materials rendered in the forward rendering pass). You should set the nonzero value to increase performance: it is not recommended to use more than 4 Voxel Probes per object.
Range of values: [0, 128]. The default value is : 4.
Console access: render_lights_forward_per_object_voxel (API control)
Last update: 2023-12-19
Build: ()