Environment Probe

Environment Probe is a light source which also provides reflections on an object inside the probe by using a cubemap (pre-baked or dynamically changing each frame). In UNIGINE, Environment Probe has three types of projections:

Box Projection — works better for indoor scenes (when the room has a 3D box shape) or box-shaped outdoor scenes (back alley between buildings).
Spherical Projection — works better for spherical-shape cases.
Raymarching — works for all other cases, the probe renders reflections taking various shapes of surrounding surfaces into account. Lighting is calculated using physically-correct formulas ensuring that reflections as well as diffuse lighting become more realistic in comparison with Box and Sphere projections, and consequently more resource-consuming.

With Environment Probe you can create reflections instead of creating reflection materials.

Notice

By default Environment Probe is used for reflections only; as for lighting, it is recommended to simulate it using Voxel Probe and Lightmaps. This approach ensures the best result, however you can still use Environment Probe for ambient lighting.

Multiple Environment Probe for Transparent Objects#

The Multiple Environment Probes option set for a transparent object (rendered in the forward pass) allows several Environment Probe nodes affect the object and map their cubemaps to it.

When the option is disabled, only the last set Environment Probe will affect the object. At that, the entire object must be inside the radius of Environment Probe. Otherwise, it won't be affected by this Environment Probe at all.
When the option is enabled, the object will be lit by the whole Environment Probe: each probe will affect the part of the object, which is inside the probe. Cubemaps of Environment Probe nodes will be blended in the intercrossing areas.

NoticeRendering of multiple Environment Probe nodes must be enabled via Rendering -> Transparent -> Multiple Environment Probes.


Multiple Environment Probes is off: only the left cubemap is mapped to the object	Multiple Environment Probes is on: both cubemaps are mapped and blended

To add an Environment Probe node to the scene via UnigineEditor, do the following:

Run the project with UnigineEditor.
On the Menu bar, click Create -> Lights and select the required Environment Probe: Box, Sphere, or Raymarching. The projection shape can be changed after it is created via the Parameters window.
Place Environment Probe.
Grab the cubemap texture for Environment Probe. You can grab it via the Parameters window or use the Bake Lighting tool.
Adjust the Environment Probe settings.

Notice

You can't bake realtime lights (Omni Light, Projected Light, etc.) to Environment Probe. The best you can do is to place spheres with emission materials instead of lights, adjust emission intensity and then bake lighting. However, the result will look worse than you'd have with realtime lights.
Use the Bake to Environment Probes option to define if a surface should have its reflections baked to Environment Probe.

When Environment Probe is selected in the UnigineEditor viewport, reference spheres are visualized in the center of the probe:

Indirect Specular sphere helps in estimating the reflection provided by the probe.
Indirect Diffuse sphere helps in estimating the ambient lighting provided by the probe (requires Indirect Diffuse lighting to be enabled).

The Environment Probe settings can be found in the Node tab of the Parameters window. This tab contains both the parameters attributable to all light sources and the parameters specific for Environment Probe. The specific parameters are described below.

Common Parameters#

Projection Type used by Environment Probe:	Box Projection — works better for indoor scenes (when the room has a 3D box shape) or box-shaped outdoor scenes (back alley between buildings). Sphere Projection — works better for spherical-shape cases. Raymarching — works for all other cases, the probe renders reflections taking various shapes of surrounding surfaces into account. Lighting is calculated using physically-correct formulas ensuring that reflections as well as diffuse lighting become more realistic in comparison with Box and Sphere projections, and consequently more resource-consuming.
Box Projection Size	Specifies the size of the box projection.
Attenuation Distance	Sets the attenuation distance for Environment Probe.
Attenuation Power	Sets the attenuation power for Environment Probe.

Render Parameters#

Color	Sets the light color in the RGBA format. The color defines both the plausibility of virtual representation and its aesthetic component.
Intensity	Sets the light color multiplier, which provides fine control over color intensity of the emitted light: The minimum value of 1 corresponds to the least saturated light color. The maximum value of 100 equals the most bright and intense color.
Shadow Mask	The Shadow mask controls rendering of a shadow cast by an object lit by a light source.
Viewport Mask	Sets the Viewport mask for the light.
Visibility Distance	Distance from the camera, in units, up to which Environment Probe will be rendered.
Fade Distance	Distance from the camera, in units, starting from which Environment Probe starts to fade out gradually.
Render On Water	Renders Environment Probe on water.
Render On Transparent	Renders Environment Probe on transparent objects.
Multiply By Sky Color	Enables the influence of sun light color on Environment Probe. Notice When enabled, this option makes the Environment Probe color black at night, or orange at sunset.
Additive Blending	Enables the additive blending mode for Environment Probe. This option offers more flexibility in lighting and reflections control. You can use it to blend lighting and reflections of several Environment Probe nodes together and control them separately.
Noise Frame Number	The number of variations of the noise pattern, which is changed every frame. Higher values result in a more dynamic noise effect, but a significant temporal accumulation of frames will make the image look like more rays are used. Smaller values result in a more static noise pattern.

Indirect Diffuse and Specular Parameters#

In general there are two groups of parameters:

Indirect Diffuse	Enables indirect diffuse (ambient) lighting for Environment Probe. By default, Environment Probe is used for reflections only; as for lighting, it is recommended to simulate it using Voxel Probe and Lightmaps — this approach ensures the best result. However, you can still use Environment Probe for indirect diffuse lighting by enabling this option.
Indirect Specular	Toggles specular lighting for Environment Probe.

The parameters differ depending on the Environment Probe type.

Sphere Projection#

Sphere Projection Parameters

Contrast	Sets the contrast of indirect diffuse lighting.
Parallax	Enables rendering of reflections taking into account the camera's position. When this option is disabled, reflection cubemaps are simply projected onto objects, and do not follow the viewer's perspective. 0 (minimum) — parallax correction is disabled (reflections will look like objects are infinitely distant). 1 (maximum) — parallax correction is enabled (reflections will look like objects are at the distance close to the radius of Environment Probe). Values in-between represent a linear interpolation factor for parallax correction and are to be set when Environment Probe is used to fit a medium or small object into the environment for additional correction, if necessary. Notice Parallax correction does not affect reflections on transparent objects.

Contrast

Sets the contrast of indirect diffuse lighting.

Parallax

Enables rendering of reflections taking into account the camera's position. When this option is disabled, reflection cubemaps are simply projected onto objects, and do not follow the viewer's perspective.

0 (minimum) — parallax correction is disabled (reflections will look like objects are infinitely distant).
1 (maximum) — parallax correction is enabled (reflections will look like objects are at the distance close to the radius of Environment Probe).
Values in-between represent a linear interpolation factor for parallax correction and are to be set when Environment Probe is used to fit a medium or small object into the environment for additional correction, if necessary.

Notice

Parallax correction does not affect reflections on transparent objects.

Box Projection#

Box Projection Parameters

Ambient Parallax	Enables the global illumination simulation. Environment Probe generates fake GI by using the cubemap.
Contrast	Sets the contrast of indirect diffuse lighting.
Gloss Corners	The intensity of reflection gloss near the box projection corners.

Raymarching#

Raymarching Parameters

Num Rays	The number of rays per pixel that are used to calculate diffuse/specular reflections from rough surfaces. Using more rays provides more precise reflection roughness calculation, however, it is more expensive.
Num Steps	The number of steps per ray that are used for trace calculation. The number of steps defines accuracy of indirect light / reflections and causes a reasonable performance impact. The higher the value, the more accurate obstacles between objects are taken into account.
Step Size	The size of the trace step used for the diffuse/specular reflection calculation. Higher values result in longer traces (however, tiny objects may become missing), lower values produce more detailed reflections of tiny objects.
Num Steps Roughness Threshold	The roughness value at which the number of steps (Num Steps) equals to 1. This is required for optimization, as calculating matte reflections as correctly as possible may be unnecessary.
Information Lost Rays Multiplier	The multiplier for the number of rays (Num Rays) in the areas where the ghosting effect usually occurs. Increasing this value reduces the ghosting, but the more ghosting cases are, the more it affects performance.
Mip Offset	The mipmap offset for the cubemap that is used for the diffuse light / specular reflections calculation. Increasing the value affects performance, lighting turns to be less detailed and realistic, small objects on the cubemap may be lost. The 0 value provides the most visually credible result, but more rays are required to eliminate the noise.
Threshold	The threshold used for the diffuse light / specular reflections calculation to limit imitation of reflections in areas where information can't be obtained. Higher values make the effect less pronounced.
Threshold Occlusion	The value that limits imitation of environment cubemap occlusion in areas where information can't be obtained. Higher values make the effect less pronounced. This parameter is mainly used for indoor environment to correct false reflections on occluded areas (false reflections are replaced with black color). For outdoor environment, higher values of this parameter are recommended.
Reconstruction Samples Screen	The number of iterations required for a more accurate detection of the screen-space ray-surface intersection. Higher values define the intersection more precisely, however significantly affect performance.
Reconstruction Samples Cubemap	The number of iterations required for a more accurate detection of the ray-surface intersection outside the screen space. Higher values define the intersection more precisely, however significantly affect performance.
Translucent Anisotropy	The value defining the extent of the light penetration through transparent surfaces. 0 — light does not penetrate through surfaces. 0.5 — light is distributed equally on both sides of the surface (along the ray direction and towards the light source) 1.0 — all light passes through the surface along the ray direction.
Replace With Diffuse Roughness Threshold	The rougness value starting from which Indirect Specular stops being calculated and is replaced with Indirect Diffuse. This setting is used to optimize matte reflections.
BRDF	The light distribution model for matte surfaces. GGX is more realistic, though increases noise and slightly reduces performance.

Baking Settings#

Notice

Re-grab the cubemap texture, when you make changes to these parameters.

Mode	Specifies if the reflection is updated in realtime or baked into a texture. Notice For the Realtime Update mode, the Dynamic Reflections option should be enabled: Rendering -> Features -> Dynamic Reflections.
Faces Per Frame	Cubemap update interval: 1 — Refresh only one face every frame. 2 — Refresh two faces every frame. 3 — Refresh three faces every frame. 4 — Refresh four faces every frame. 5 — Refresh five faces every frame. 6 — Refresh all six faces every frame. Notice Available for Realtime Update mode only.
Grab by Bake Lighting	Specifies if the cubemap texture is to be modified by the Bake Lighting Tool.
Reflection Viewport Mask	The mask that controls rendering of the Environment Probe's reflections into the reflection camera viewport.
Resolution	Resolution of the reflection texture, in pixels. Notice Setting too high resolution on a low-performance GPU with low memory capacity may cause engine crash.
Supersampling	Number of samples per pixel used for image grabbing supersampling.
Mipmaps Quality	The quality of mipmaps and roughness correction mode for reflections on rough surfaces. The following modes are available: Low — the Correct Roughness value is Low, the Mipmaps Quality value is 0.25. Medium — the Correct Roughness value is Medium, the Mipmaps Quality value is 0.5. High — the Correct Roughness value is High, the Mipmaps Quality value is 0.75. Ultra — the Correct Roughness value is Ultra, the Mipmaps Quality value is 1.0. Notice Setting too high quality on a low-performance GPU with low memory capacity may cause engine crash. Available for Realtime Update mode only.
Distance Scale	Global distance multiplier within the range of [0.0f; 1.0f] for the reflection LODs visibility distance. Distance Scale is applied to the distance measured from the reflection camera to the node (surface) bound. Notice Available for Realtime Update mode only.
Near Clipping	Distance to the near clipping plane for image grabbing.
Far Clipping	Distance to the far clipping plane for image grabbing. Notice An extremely big difference between the Near and Far Clipping Planes can cause baking the space into black. Therefore, if the required Far Clipping value is outside the range, adjust the Near Clipping value proportionately.
Sky Cutout	Cut out sky rendering in Environment Probe and renders dynamic reflection instead of the sky. Notice This parameter can be used to render changes of the sky gradient in a window, when the time of the day changes.
Local Space	Enable local space (local coordinates) for Environment Probe. Can be used for scenes with moving objects. Notice It is recommended to use this parameter, if you plan to rotate the Environment Probe after baking.
Notice You can use the following 7 visibility options together with additive blending to provide more flexibility in light baking. Thus, you can make Environment 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 Environment Probe.
Visibility Light World	Enables baking of World Light sources to Environment Probe.
Visibility Light Omni	Enables baking of Omni Light sources to Environment Probe.
Visibility Light Proj	Enables baking of Projected Light sources to Environment Probe.
Visibility Voxel Probe	Enables baking of other Voxel Probe light sources to Environment Probe.
Visibility Environment Probe	Enables baking of Environment Probe light sources to the Environment Probe.
Visibility Emission	Enables baking of emission light sources to Environment Probe.
Visibility Lightmap	Enables baking of lightmapped surfaces to Environment Probe.
Texture	Cubemap texture for reflection. Notice Every bake lighting procedure makes changes to the asset selected in this field when the Grab by Bake Lighting mode is enabled. 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.
Cutout By Shadow	Enables clipping of reflections occluded by obstacles (located in shadowed areas relative to the light source). This feature uses the depth texture grabbed for Environment Probe to determine reflections that should be visible. Notice This feature does not work with the Realtime Update mode enabled and does not clip reflections for transparent objects. The feature takes into account only the shadows cast by surfaces using the Cast Environment Probe Shadows option. When enabled, the three parameters listed below (Bias, Normal Bias, and Depth Texture) are available.
Bias	Bias that is used to correct inexact shadowing of the scene objects for the Cutout By Shadow feature. It controls the depth offset added to the current depth value stored in the shadow map. Similar to the Bias parameter for shadows.
Normal Bias	Bias obtained for the Cutout By Shadow feature by shifting the surface on which the shadow falls. The surface is shifted along normals stored in the normal map. Similar to the Normal Bias parameter for shadows.
Depth Texture	Depth texture used for clipping reflections occluded by obstacles. Notice This texture is static and requires re-generation each time the Environment Probe position or size is changed. To grab the depth texture for clipping perform the following steps: Place Environment Probe to the desired location and adjust its size, if necessary. Disable all nodes that should not be taken into account when calculating occluded (shadowed) areas. Enable the Cutout By Shadow feature and make sure that the Grab by Bake Lighting mode is also enabled. Click Show Bake Lighting and in the window that appears click Bake Selected Probe. After the textures are generated, you can enable or disable clipping at run time. Notice Every bake lighting procedure makes changes to the asset selected in this field when the Grab by Bake Lighting mode together with the Cutout By Shadow mode are enabled. You can leave the field empty to avoid losing content. In this case a new generated depth texture will be set for this parameter after the bake lighting procedure. Generated textures are stored in the data/bake_lighting folder.

In This Article:

See Also#

Overview#

Multiple Environment Probe for Transparent Objects#

Adding Environment Probe#