LightmapGIData

继承: Resource < RefCounted < Object

Contains baked lightmap and dynamic object probe data for LightmapGI.

描述

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

属性

方法

voidadd_user ( path: NodePath, uv_scale: Rect2, slice_index: int, sub_instance: int )
voidclear_users ( )
intget_user_count ( ) const1
NodePathget_user_path ( user_idx: int ) const1
boolis_using_spherical_harmonics ( ) const1
voidset_uses_spherical_harmonics ( uses_spherical_harmonics: bool )

属性说明

TextureLayered light_texture

已弃用: 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.


方法说明

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 ( ) const1

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


NodePath get_user_path ( user_idx: int ) const1

Returns the NodePath of the baked object at index user_idx.


bool is_using_spherical_harmonics ( ) const1

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.

2

本方法通常需要用户覆盖才能生效。

1

本方法无副作用,不会修改该实例的任何成员变量。

3

本方法除了能接受在此处描述的参数外,还能够继续接受任意数量的参数。

4

本方法用于构造某个类型。

5

调用本方法无需实例,可直接使用类名进行调用。

6

本方法描述的是使用本类型作为左操作数的有效运算符。

7

这个值是由下列位标志构成位掩码的整数。

8

无返回值。