BakedLightmap

Category: Core

Prerendered indirect light map for a scene.

Properties

	bake ( from_node=null, bool create_visual_debug=false )
void	( )

Enumerations

enum BakeQuality:

BAKE_QUALITY_LOW = 0 — Lowest bake quality mode. Fastest to calculate.
BAKE_QUALITY_HIGH = 2 — Highest bake quality mode. Takes longer to calculate.

enum BakeMode:

BAKE_MODE_CONE_TRACE = 0 — Less precise but faster bake mode.
BAKE_MODE_RAY_TRACE = 1 — More precise bake mode but can take considerably longer to bake.

enum BakeError:

BAKE_ERROR_OK = 0
BAKE_ERROR_NO_SAVE_PATH = 1
BAKE_ERROR_NO_MESHES = 2
BAKE_ERROR_CANT_CREATE_IMAGE = 3
BAKE_ERROR_USER_ABORTED = 4

Tutorials

Baked lightmaps

Setter	set_bake_cell_size(value)
Getter	get_bake_cell_size()

Grid subdivision size for lightmapper calculation. Default value of will work for most cases. Increase for better lighting on small details or if your scene is very large.

bake_energy

Setter	set_energy(value)
Getter	get_energy()

Multiplies the light sources’ intensity by this value. For instance, if the value is set to 2, lights will be twice as bright. If the value is set to 0.5, lights will be half as bright.

Vector3 bake_extents

bake_hdr

Setter	set_hdr(value)
Getter	is_hdr()

If , lightmap can capture light values greater than . Turning this off will result in a smaller lightmap. Default value:.

BakeMode bake_mode

Setter	set_bake_mode(value)
Getter	get_bake_mode()

Lightmapping mode. See .

float bake_propagation

Setter	set_propagation(value)
Getter	get_propagation()

Defines how far the light will travel before it is no longer effective. The higher the number, the farther the light will travel. For instance, if the value is set to 2, the light will go twice as far. If the value is set to 0.5, the light will only go half as far.

bake_quality

float capture_cell_size

Setter	set_capture_cell_size(value)
Getter	get_capture_cell_size()

Grid size used for real-time capture information on dynamic objects. Cannot be larger than .

String image_path

Setter	set_image_path(value)
Getter	get_image_path()

Location where lightmaps will be saved.

light_data

Setter	set_light_data(value)
Getter	get_light_data()

The calculated light data.

Method Descriptions

Bakes the lightmaps within the currently edited scene.

void debug_bake ( )

Executes a dry run bake of lightmaps within the currently edited scene.