Unigine.BakeLighting Class

This class allows you to bake lighting.

Properties:

Name	Description
int Progress	Overall progress of light baking.
int ProgressBounce	A value showing progress of calculating current bounce.
int ProgressLight	Progress of light baking for the current LightVoxelProbe at the moment.
int CurrentBounce	A bounce being calculated at the moment.
Light CurrentLight	An instance of the LightVoxelProbe being calculated at the moment.
float Timer	The time elapsed from the start of the process of baking.
float VoxelSizeMultiplier	The value of the voxel size multiplier parameter.
int Bounces	Number of all bounces.
int VoxelsPerFrame	Return number of voxels computed and visualized per single frame.
bool IsBaking	A value indicating if the process of baking is being performed at the moment.

Methods:

Name	Description View: Sort by:
BakeEnvironmentProbes	Starts the process of light baking for all environment probes in the scene.
BakeVoxelProbes	Starts the process of light baking for all voxel probes in the scene.
Bake	Starts the process of light baking for the all voxel and environment probes and shadow baking for omni and proj light sources in static light mode in the given list.
BakeAll	Starts the process of light baking for all voxel and environment probes and shadow baking for all omni and proj light sources in static light mode in the scene.
Stop	Interrupts the process of light baking, if it is in performing state.
AddReadOnlyTexture	Adds a read-only texture with the specified GUID.
RemoveReadOnlyTexture	Removes the read-only texture with the specified GUID.

BakeLighting Class

Properties

int Progress#

Overall progress of light baking.

NoticeIf the process of baking is not being performed at the moment, 0 is returned.

int ProgressBounce#

A value showing progress of calculating current bounce.

int ProgressLight#

Progress of light baking for the current LightVoxelProbe at the moment.

int CurrentBounce#

A bounce being calculated at the moment.

NoticeIf the process of baking is not being performed at the moment, 1 is returned.

Light CurrentLight#

An instance of the LightVoxelProbe being calculated at the moment.

float Timer#

The time elapsed from the start of the process of baking.

float VoxelSizeMultiplier#

The value of the voxel size multiplier parameter. by default, it is equal to 1.0f.

set

Sets the value of the voxel size multiplier parameter.

set value - Voxel size multiplier within the [0.0f, 8.0f] range. The default value is 1.

int Bounces#

Number of all bounces.

set

Sets number of bounces.

set value - Number of bounces within the [1, 32] range. The default value is 1.

int VoxelsPerFrame#

Return number of voxels computed and visualized per single frame.

set

Sets number of voxels computed and visualized per single frame.

set value - Number of voxels per frame within the [1, 100] range. The default value is 1.

Notice

High values cause longer user interface response.

bool IsBaking#

A value indicating if the process of baking is being performed at the moment.

Members

void BakeEnvironmentProbes ( ) #

Starts the process of light baking for all environment probes in the scene.

void BakeVoxelProbes ( ) #

Starts the process of light baking for all voxel probes in the scene.

void Bake ( Node[] probes ) #

Starts the process of light baking for the all voxel and environment probes and shadow baking for omni and proj light sources in static light mode in the given list.

Arguments

Node[] probes - List of voxel and environment probe nodes for which the process of light baking is to be performed and omni and proj light sources in static light mode for which the process of shadow baking is to be performed.
Notice
The order of nodes added for baking is not important.

void BakeAll ( ) #

Starts the process of light baking for all voxel and environment probes and shadow baking for all omni and proj light sources in static light mode in the scene.

void Stop ( ) #

Interrupts the process of light baking, if it is in performing state.

void AddReadOnlyTexture ( UGUID guid ) #

Adds a read-only texture with the specified GUID.

Arguments

UGUID guid - GUID of the read-only texture to be added.

void RemoveReadOnlyTexture ( UGUID guid ) #

Removes the read-only texture with the specified GUID.

Arguments

UGUID guid - GUID of the read-only texture to be removed.

Last update: 31.07.2020

Помогите сделать статью лучше

Была ли эта статья полезной?

Сообщить о проблеме в этой статье

(или выберите слово/фразу и нажмите Ctrl+Enter