BakedLightmap

Inherits: VisualInstance < Spatial < Node < Object

Prerendered indirect light map for a scene.

Description

Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the GIProbe approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time.

Note: This node has many known bugs and will be rewritten for Godot 4.0. See GitHub issue #30929.

Tutorials

• Baked lightmaps

Properties

float	bake_cell_size	0.25
float	bake_default_texels_per_unit	20.0
float	bake_energy	1.0
Vector3	bake_extents	Vector3( 10, 10, 10 )
bool	bake_hdr	false
BakeMode	bake_mode	0
float	bake_propagation	1.0
BakeQuality	bake_quality	1
float	capture_cell_size	0.5
String	image_path	"."
BakedLightmapData	light_data

Methods

BakeError	bake ( Node from_node=null, bool create_visual_debug=false )
void	debug_bake ( )

Enumerations

enum BakeQuality:

• BAKE_QUALITY_LOW = 0 --- The lowest bake quality mode. Fastest to calculate.
• BAKE_QUALITY_MEDIUM = 1 --- The default bake quality mode.
• BAKE_QUALITY_HIGH = 2 --- The 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 --- Baking was successful.
• BAKE_ERROR_NO_SAVE_PATH = 1 --- Returns if no viable save path is found. This can happen where an image_path is not specified or when the save location is invalid.
• BAKE_ERROR_NO_MESHES = 2 --- Currently unused.
• BAKE_ERROR_CANT_CREATE_IMAGE = 3 --- Returns when the baker cannot save per-mesh textures to file.
• BAKE_ERROR_USER_ABORTED = 4 --- Returns if user cancels baking.

Property Descriptions

float bake_cell_size

Default	0.25
Setter	set_bake_cell_size(value)
Getter	get_bake_cell_size()

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

float bake_default_texels_per_unit

Default	20.0
Setter	set_bake_default_texels_per_unit(value)
Getter	get_bake_default_texels_per_unit()

If a Mesh.lightmap_size_hint isn't specified, the lightmap baker will dynamically set the lightmap size using this value. This value is measured in texels per world unit. The maximum lightmap texture size is 4096x4096.

float bake_energy

Default	1.0
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

Default	Vector3( 10, 10, 10 )
Setter	set_extents(value)
Getter	get_extents()

The size of the affected area.

bool bake_hdr

Default	false
Setter	set_hdr(value)
Getter	is_hdr()

If true, the lightmap can capture light values greater than 1.0. Turning this off will result in a smaller file size.

BakeMode bake_mode

Default	0
Setter	set_bake_mode(value)
Getter	get_bake_mode()

Lightmapping mode. See BakeMode.

float bake_propagation

Default	1.0
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.

BakeQuality bake_quality

Default	1
Setter	set_bake_quality(value)
Getter	get_bake_quality()

Three quality modes are available. Higher quality requires more rendering time. See BakeQuality.

float capture_cell_size

Default	0.5
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 bake_cell_size.

String image_path

Default	"."
Setter	set_image_path(value)
Getter	get_image_path()

The location where lightmaps will be saved.

BakedLightmapData light_data

Setter	set_light_data(value)
Getter	get_light_data()

The calculated light data.

Method Descriptions

BakeError bake ( Node from_node=null, bool create_visual_debug=false )

Bakes the lightmaps within the currently edited scene. Returns a BakeError to signify if the bake was successful, or if unsuccessful, how the bake failed.

void debug_bake ( )

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