Up to date

This page is up to date for Godot 4.3. If you still find outdated information, please open an issue.

LightmapGIData

Inherits: Resource < RefCounted < Object

Contains baked lightmap and dynamic object probe data for LightmapGI.

Description

LightmapGIData contains baked lightmap and dynamic object probe data for LightmapGI. It is replaced every time lightmaps are baked in LightmapGI.

Properties

TextureLayered

light_texture

Array[TextureLayered]

lightmap_textures

[]

Methods

void

add_user(path: NodePath, uv_scale: Rect2, slice_index: int, sub_instance: int)

void

clear_users()

int

get_user_count() const

NodePath

get_user_path(user_idx: int) const

bool

is_using_spherical_harmonics() const

void

set_uses_spherical_harmonics(uses_spherical_harmonics: bool)

Property Descriptions

TextureLayered light_texture 🔗

Deprecated: The lightmap atlas can now contain multiple textures. See lightmap_textures.

The lightmap atlas texture generated by the lightmapper.

Array[TextureLayered] lightmap_textures = [] 🔗

The lightmap atlas textures generated by the lightmapper.

Method Descriptions

void add_user(path: NodePath, uv_scale: Rect2, slice_index: int, sub_instance: int) 🔗

Adds an object that is considered baked within this LightmapGIData.

void clear_users() 🔗

Clear all objects that are considered baked within this LightmapGIData.

int get_user_count() const 🔗

Returns the number of objects that are considered baked within this LightmapGIData.

NodePath get_user_path(user_idx: int) const 🔗

Returns the NodePath of the baked object at index user_idx.

bool is_using_spherical_harmonics() const 🔗

If true, lightmaps were baked with directional information. See also LightmapGI.directional.

void set_uses_spherical_harmonics(uses_spherical_harmonics: bool) 🔗

If uses_spherical_harmonics is true, tells the engine to treat the lightmap data as if it was baked with directional information.

Note: Changing this value on already baked lightmaps will not cause them to be baked again. This means the material appearance will look incorrect until lightmaps are baked again, in which case the value set here is discarded as the entire LightmapGIData resource is replaced by the lightmapper.