Unigine.LightEnvironmentProbe Class
| Inherits from: | Light |
This class allows creating and managing environment probes.
LightEnvironmentProbe Class
Properties
Texture Texture#
The Grabs the cube texture (RGBA16F) containing the rendered environment probe and saves it into the given Texture instance.
string TexturePath#
The path to the reflection cube texture used for the environment probe.
float AmbientContrast#
The current ambient contrast value for the environment probe.
bool AmbientEnabled#
The A value indicating if ambient lighting for the environment probe is enabled.
float Parallax#
The current parallax correction value for reflection cubemaps projected by the environment probe. by the minimum value of 0 reflection cubemaps are simply projected onto objects, and do not follow the viewer's perspective. This causes an unrealistic-looking reflection for most surfaces. Parallax correction enables to take camera's position into account.
Notice
Parallax correction is not available for reflections on transparent objects.
float ZFar#
The distance to the far clipping plane used for image grabbing (available only when the Dynamic flag is set to 0).
float ZNear#
The distance to the near clipping plane used for image grabbing (available only when the Dynamic flag is set to 0).
int ReflectionViewportMask#
The mask that specifies materials for which reflections are to be rendered in the viewport.
Notice
The reflection viewport mask can be specified only for dynamic reflections (when the Dynamic flag is set to 1).
int Supersampling#
The A value indicating if supersampling for image grabbing is enabled (available only when the Dynamic flag is set to 0).
int Resolution#
The current resolution of the reflection mask in pixels (available only when the Dynamic flag is set to 0).
int RenderFacesPerFrame#
The current update interval set for the cube texture used for dynamic reflections.
vec3 BoxSize#
The current box size for the environment probe (available only when the Box projection flag is set to 1).
float BoxGlossCorners#
The current value of the coefficient that controls glossiness of reflections in the corners of box projection.
Notice
Available only when the Box projection flag is set to 1.
float BoxGI#
The current gi factor for box projection.
Notice
Available only when the Box projection flag is set to 1.
bool LocalSpace#
The true to enable local space; otherwise, false.
bool CutoutByShadow#
The A value indicating if clipping of reflections occluded by obstacles is enabled. this feature uses the depth texture grabbed for the environment probe to determine reflections that should be visible.
bool SkyCutout#
The A value indicating if sky cutout for image grabbing is enabled (available only when the Dynamic flag is set to 0).
bool AdditiveBlending#
The A value indicating if additive blending is enabled for the environment probe. this option offers more flexibility in reflections control. you can use it to blend reflections of several environment probes together and control them separately.
bool UseSunColor#
The A value indicating if sun color modulation for the environment probe is enabled. this parameter can be used for outdoor-baked environment probes.
bool BoxProjection#
The A value indicating if box projection is enabled for the environment probe.
bool GrabByBakeLighting#
The A value indicating whether the cubemap texture is to be modified by the Bake Lighting Tool.
bool Dynamic#
The value indicating if reflections are dynamic (the cubemap is generated dynamically).
float DistanceScale#
The current distance scale for the reflection.
vec3 AttenuationDistance#
The distance from the light source shape, at which the light source doesn't illuminate anything.
Render.CORRECT_ROUGHNESS DynamicCorrectRoughness#
The One of the CORRECT_ROUGHNESS_* modes.
bool BakeVisibilityLightmap#
The 1 if lightmapped surfaces are to be baked to the environment probe; otherwise, 0.
bool BakeVisibilityVoxelProbe#
The A value indicating if other voxel probe light sources are to be baked to the voxel probe. you can use this option together with additive blending to provide more flexibility in light baking. Thus, you can make voxel probes independent of each other and combine them to produce some sort of dynamic GI effect.
bool BakeVisibilityEnvironmentProbe#
The A value indicating if environment probe light sources are to be baked to the environment probe. you can use this option together with additive blending to provide more flexibility in light baking. Thus, you can make voxel probes independent of each other and combine them to produce some sort of dynamic GI effect.
bool BakeVisibilityLightProj#
The 1 if the projected light sources are to be baked to the environment probe; otherwise, 0.
bool BakeVisibilityLightOmni#
The 1 if omni light sources are to be baked to the environment probe; otherwise, 0.
bool BakeVisibilityLightWorld#
The 1 if world light sources are to be baked to the environment probe; otherwise, 0.
bool BakeVisibilitySky#
The 1 if lighting from the sky is to be baked to the environment probe; otherwise, 0.
bool BakeVisibilityEmission#
The 1 if emission light sources are to be baked to the environment probe; otherwise, 0.
float BakeMipmapsQuality#
The Mipmaps quality.
Members
LightEnvironmentProbe ( vec4 color, vec3 attenuation_distance, string name = 0 ) #
Constructor. Creates a new environment probe with cubemap modulation based on given parameters.Arguments
- vec4 color - Color of the environment probe.
- vec3 attenuation_distance - Radii of the environment probe.
- string name - Path to a cube texture of the environment probe.
int SetTextureImage ( Image image, bool dynamic = 0 ) #
Sets the given image as the cube texture of the environment probe. If you need to set the cube texture for all environment probes in the scene, set the dynamic flag to 1.Arguments
- Image image - Cube texture to set.
- bool dynamic - Dynamic texture flag:
- If set to false, changing the cube texture of the current environment probe will also affect all environment probes in the scene.
- If set to true, a cube texture will be successfully set only for the current environment probe.
Return value
1 if the cube texture is set successfully; otherwise, 0.int GetTextureImage ( Image image ) #
Grabs the cube texture (RGBA16F) containing the rendered environment probe and saves it into the given Image instance.Arguments
- Image image - Image into which the texture is saved.
Return value
1 if the cube texture has been grabbed successfully; otherwise, 0.static int type ( ) #
Returns the type of the node.Return value
LightEnvironmentProbe type identifier.Last update:
2022-12-14
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)