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

Voxel Probe

Voxel Probe is a light source which provides static voxel lighting and shading on an object inside Voxel Probe by using a prebaked 3D lighting map. Voxel Probe stores information on indirect lighting (light bounces) only, no direct lighting data at all. Unlike Environment Probe, Voxel Probe provides physically accurate light spreading inside interiors and outdoor static scenes but supports diffuse reflections only.

Also, Voxel Probe is great solution for shading dynamic objects within static areas.

Notice
Surfaces with enabled Lightmaps are not illuminated by Voxel Probe.

See Also#

Overview#

Voxel Probe provides box volume composed of voxels and contains parameters used for light baking inside it.

Voxel Probe projects a 3D lighting texture on objects inside it thus providing indirect lighting simulation.

Notice
For a transparent object (with Alpha Blending enabled) to be affected by Voxel Probe, you should toggle on the Multiple Environment Probes state of its material and enable the Multiple Environment Probes feature (via Rendering -> Transparent -> Multiple Environment Probes).

The texture should have an appropriate resolution which is calculated the following way:

Resolution = Width × Height × (Depth × 6)

Each pixel of a texture defines the illuminance of a certain voxel face.

An example of a 3D lighting texture

The inner space of Voxel Probe is visualized using spheres. These spheres are used to show the illumination in each voxel from all directions. The visualizer is disabled by default. To enable it, use the Helpers menu in Editor Viewport:

Voxel Probe Visualizer settings:

  • Grid Size — number of spheres in every row/column, the value from 7 to 40.
  • Sphere Scale — size of the visualizing sphere.

Voxel Probe is a required object for the Voxel-Based GI feature, which enables you to generate a lighting texture for Voxel Probe and simulate global illumination with indirect lighting for both, interiors and outdoor scenes.

Notice
By default, Voxel Probe is used for lighting only; as for reflectons, it is recommended to simulate them using Environment Probe. This approach ensures the best result, however you can still enable reflections for Voxel Probe.

Adding Voxel Probe#

To add Voxel Probe to the scene via UnigineEditor, do the following:

  1. On the Menu bar, click Create -> Light -> Voxel Probe.

  2. Place Voxel Probe somewhere in the world.
  3. Bake Lighting or set the Texture parameter by choosing a prebaked lighting texture from assets.
Notice
Use the Cast GI option to define if a surface should be baked to Voxel Probe.

Voxel Probe Settings#

Parameters of Voxel Probe are available in the Node tab of the Parameters window. It contains both the common and the specific parameters. A set of parameters specific for Voxel Probe is described below.

Warning
Do not use the Scale transform parameter to change Voxel Probe size as it causes visual artifacts.

Voxel Probe parameters

Common Parameters#

Box Size Specifies the size of the box volume.
Voxel Size

Sets the size of a voxel.

Notice
If the Box Size is not divisible to the Voxel Size without remainder, Voxel Probe uses the lowest volume of voxels covering the box.
Notice
These two parameters define the resolution of Voxel Probe. Note that the memory usage is cubically dependent on the resolution, double growth of the voxel size causes eight-times growth of the size of the lighting texture.

Render Parameters#

Additive Blending

Enables the additive blending mode for Voxel Probe. This option offers more flexibility in lighting control. You can use it to blend lighting of several Voxel Probe nodes together and control them separately (e.g. make a separate Voxel Probe for an indoor emissive light source and blend it with another Voxel Probe with lighting baked from the sky, having the ability to enable and disable them separately).

Notice
Voxel Probe with additive blending enabled cannot be used as an inset to add lighting details (e.g. creating a small high-detail Voxel Probe inside a large low-detail one). Such nodes do not replace each other, as they are blended instead.
Use Sun Color

Enables the influence of sun light color on Voxel Probe. When enabled, this option makes the Voxel Probe color black at night, or orange at sunset.

Notice

To bake lighting from the sky separately with this option enabled, it is recommended to enable baking visibility for the sky only, while disabling it for other light sources.

Changing this option requires the lighting to be re-baked.

Ambient Parameters#

Bias Sets the bias of ambient lighting by adjusting the voxels offset for fine tuning.
Cubic Filtering

Enables the cubic filtering of ambient lighting.

Notice
When disabled, the linear filtering is used.

Reflections Parameters#

Enabled Enables reflections for Voxel Probe. By default, Voxel Probe is used for lighting only; as for reflectons, it is recommended to simulate them using Environment Probe. This approach ensures the best result, however you can still enable reflections for Voxel Probe via this option.
Visibility Roughness Min Sets the lower bound of the roughness range within which the reflections of Voxel Probe are visible.
Visibility Roughness Max

Sets the higher bound of the roughness range within which the reflections of Voxel Probe are visible.

Notice
The roughness range helps to choose between diffuse reflection of the Voxel Probe and other ones (reflection from an environment probe, the environment cubemap) for all materials having the Roughness parameter.
Bias Sets the bias of reflection by adjusting the voxels offset for fine tuning.
Cubic Filtering

Enables the cubic filtering of reflection.

Notice
When disabled, the linear filtering is used.

Baking Settings#

Notice
The following parameters describe the way the light shall be baked inside Voxel Probe, so you need to re-bake lighting, when you make changes to these parameters.
Baking Viewport Mask Sets the baking Viewport mask which specifies the surfaces to be baked basing on their material's Viewport mask.
Far Clipping

Sets the distance to the far clipping plane used for every voxel during light baking.

Bake Quality

Defines the baking quality preset for Voxel Probe.

  • Draft option provides the highest iterativity with the lowest sampling quality and number of rays simulated.
  • Low option provides low sampling quality and number of light rays simulated.
  • Medium option corresponds to stable quality level which is good for most cases.
  • High option corresponds to high sampling quality and number of light rays simulated intended for release production.
  • Ultra baking quality might be useful to get rid of small inconsistencies on the release production.
Bake Internal Volume

Defines the mode of internal volume baking of Voxel Probe.

  • Full option corresponds to baking all voxels of Voxel Probe in the full resolution.
  • Half option corresponds to baking all voxels of Voxel Probe as follows: voxels that cover geometry are baked in the full resolution and empty voxels are baked in the half resolution.

Having baked internal volume makes it possible to realistically shade dynamic objects that move inside Voxel Probe as the lighting texture is projected onto all the geometry.

Notice
You can use the following 7 visibility options together with additive blending to provide more flexibility in light baking. Thus, you can make Voxel Probe nodes independent of each other and combine them to produce some sort of dynamic GI effect.
Visibility Sky Enables baking of lighting from the sky to Voxel Probe.
Visibility Light World Enables baking of Light World to Voxel Probe.
Visibility Light Omni Enables baking of Light Omni to Voxel Probe.
Visibility Light Proj Enables baking of Light Projected to Voxel Probe.
Visibility Voxel Probe Enables baking of other Voxel Probe light sources to Voxel Probe.
Visibility Environment Probe Enables baking of Environment Probe light sources to Voxel Probe.
Visibility Emission Enables baking of emission light sources to Voxel Probe.
Visibility Lightmap Enables baking of lightmapped surfaces to Voxel Probe.
Texture

Sets the 3D lighting texture.

Notice

Every bake lighting procedure makes changes to the asset which is set for this parameter.

You can leave the field empty to avoid losing content. In this case a new generated lighting texture will be set for this parameter after the bake lighting procedure. Generated textures are stored in the data/bake_lighting folder.

Last update: 2022-12-14
Build: ()