VoxelGIData

Inherits: Resource < RefCounted < Object

Contains baked voxel global illumination data for use in a VoxelGI node.

Description

VoxelGIData contains baked voxel global illumination for use in a VoxelGI node. VoxelGIData also offers several properties to adjust the final appearance of the global illumination. These properties can be adjusted at run-time without having to bake the VoxelGI node again.

Note: To prevent text-based scene files (.tscn) from growing too much and becoming slow to load and save, always save VoxelGIData to an external binary resource file (.res) instead of embedding it within the scene. This can be done by clicking the dropdown arrow next to the VoxelGIData resource, choosing Edit, clicking the floppy disk icon at the top of the inspector then choosing Save As....

Tutorials

Properties

float

bias

1.5

float

dynamic_range

2.0

float

energy

1.0

bool

interior

false

float

normal_bias

0.0

float

propagation

0.5

bool

use_two_bounces

true

Methods

void

allocate ( Transform3D to_cell_xform, AABB aabb, Vector3 octree_size, PackedByteArray octree_cells, PackedByteArray data_cells, PackedByteArray distance_field, PackedInt32Array level_counts )

AABB

get_bounds ( ) const

PackedByteArray

get_data_cells ( ) const

PackedInt32Array

get_level_counts ( ) const

PackedByteArray

get_octree_cells ( ) const

Vector3

get_octree_size ( ) const

Transform3D

get_to_cell_xform ( ) const

Property Descriptions

Default

1.5

Setter

set_bias(value)

Getter

get_bias()

The normal bias to use for indirect lighting and reflections. Higher values reduce self-reflections visible in non-rough materials, at the cost of more visible light leaking and flatter-looking indirect lighting. To prioritize hiding self-reflections over lighting quality, set bias to 0.0 and normal_bias to a value between 1.0 and 2.0.


Default

2.0

Setter

set_dynamic_range(value)

Getter

get_dynamic_range()

The dynamic range to use (1.0 represents a low dynamic range scene brightness). Higher values can be used to provide brighter indirect lighting, at the cost of more visible color banding in dark areas (both in indirect lighting and reflections). To avoid color banding, it's recommended to use the lowest value that does not result in visible light clipping.


Default

1.0

Setter

set_energy(value)

Getter

get_energy()

The energy of the indirect lighting and reflections produced by the VoxelGI node. Higher values result in brighter indirect lighting. If indirect lighting looks too flat, try decreasing propagation while increasing energy at the same time. See also use_two_bounces which influences the indirect lighting's effective brightness.


Default

false

Setter

set_interior(value)

Getter

is_interior()

If true, Environment lighting is ignored by the VoxelGI node. If false, Environment lighting is taken into account by the VoxelGI node. Environment lighting updates in real-time, which means it can be changed without having to bake the VoxelGI node again.


Default

0.0

Setter

set_normal_bias(value)

Getter

get_normal_bias()

The normal bias to use for indirect lighting and reflections. Higher values reduce self-reflections visible in non-rough materials, at the cost of more visible light leaking and flatter-looking indirect lighting. See also bias. To prioritize hiding self-reflections over lighting quality, set bias to 0.0 and normal_bias to a value between 1.0 and 2.0.


Default

0.5

Setter

set_propagation(value)

Getter

get_propagation()

The multiplier to use when light bounces off a surface. Higher values result in brighter indirect lighting. If indirect lighting looks too flat, try decreasing propagation while increasing energy at the same time. See also use_two_bounces which influences the indirect lighting's effective brightness.


  • bool use_two_bounces

Default

true

Setter

set_use_two_bounces(value)

Getter

is_using_two_bounces()

If true, performs two bounces of indirect lighting instead of one. This makes indirect lighting look more natural and brighter at a small performance cost. The second bounce is also visible in reflections. If the scene appears too bright after enabling use_two_bounces, adjust propagation and energy.

Method Descriptions


  • AABB get_bounds ( ) const

Returns the bounds of the baked voxel data as an AABB, which should match VoxelGI.extents after being baked (which only contains the size as a Vector3).

Note: If the extents were modified without baking the VoxelGI data, then the value of get_bounds and VoxelGI.extents will not match.





  • Vector3 get_octree_size ( ) const