Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

LightmapGIData

Hérite de : Resource < RefCounted < Object

Contient une lightmap pré-calculée et des données de sonde d'objet dynamique pour LightmapGI.

Description

LightmapGIData contient une lightmap pré-calculée et des données de sonde d'objet dynamique pour LightmapGI. Elle est remplacée chaque fois que les lightmaps sont pré-calculées dans LightmapGI.

Propriétés

TextureLayered

light_texture

Array[TextureLayered]

lightmap_textures

[]

Array[TextureLayered]

shadowmask_textures

[]

Méthodes

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)

Énumérations

enum ShadowmaskMode: 🔗

ShadowmaskMode SHADOWMASK_MODE_NONE = 0

Le shadowmasking est désactivé. Aucune texture de shadowmask ne sera créée lors du pré-calcul des lightmaps. Les textures de shadowmask existantes seront retirées pendant le pré-calcul.

ShadowmaskMode SHADOWMASK_MODE_REPLACE = 1

Le shadowmasking est activé. Les ombres directionnelles qui sont à l'extérieur de la DirectionalLight3D.directional_shadow_max_distance seront rendues en utilisant la texture de Shadowmask. Les ombres qui sont à l'intérieur de l'intervalle seront rendues en utilisant des ombres en temps réel exclusivement. Ce mode permet d'obtenir des ombres en temps réel plus précises à proximité, sans l'effet potentiel de « barbouillage » qui peut se produire lors de l'utilisation de lightmaps avec une taille élevée de texel. Le désavantage est que lorsque la caméra se déplace rapidement, la transition entre la lumière en temps réel et le shadowmask peut être évidente. De plus, les objets qui n'ont que des ombres pré-calculées dans le shadowmask (et pas d'ombres en temps réel) n'afficheront pas d'ombres lorsqu'ils sont proches.

ShadowmaskMode SHADOWMASK_MODE_OVERLAY = 2

Le shadowmasking est activé. Les ombres directionnelles sont rendues avec des ombres en temps réel superposées sur la texture de shadowmask. Ce mode permet des transitions d'ombre plus lisses lorsque la caméra se déplace rapidement, au coût d'un effet de barbouillage potentiel pour les ombres directionnelles qui sont proches (en raison de l'ombre en temps réel qui est mélangée avec un shadowmask à basse résolution). Les objets qui n'ont que des ombres pré-calculées dans le shadowmask (et pas d'ombres en temps réel) garderont leurs ombres lorsqu'ils sont proches.

Descriptions des propriétés

TextureLayered light_texture 🔗

Obsolète : The lightmap atlas can now contain multiple textures. See lightmap_textures.

La texture de l'atlas des lightmaps générée par le lightmapper.

Array[TextureLayered] lightmap_textures = [] 🔗

Les textures de l'atlas des lightmaps générées par le lightmapper.

Array[TextureLayered] shadowmask_textures = [] 🔗

Les textures de l'atlas du shadowmask générées par le lightmapper.

Descriptions des méthodes

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

Ajoute un objet qui est considéré comme pré-calculé dans cette LightmapGIData.

void clear_users() 🔗

Retire tous les objets qui sont considérés comme pré-calculés dans cette LightmapGIData.

int get_user_count() const 🔗

Renvoie le nombre d'objets considérés comme pré-calculés dans cette LightmapGIData.

NodePath get_user_path(user_idx: int) const 🔗

Renvoie le NodePath de l'objet pré-calculé à l'index user_idx.

bool is_using_spherical_harmonics() const 🔗

Si true, les lightmaps ont été pré-calculées avec des informations directionnelles. Voir aussi LightmapGI.directional.

void set_uses_spherical_harmonics(uses_spherical_harmonics: bool) 🔗

Si uses_spherical_harmonics vaut true, indique au moteur de traiter les données de la lightmap comme si elle était pré-calculée avec des informations directionnelles.

Note : Modifier cette valeur sur les lightmaps déjà pré-calculées ne déclenchera pas un re-calcul. Cela signifie que l'apparence du matériau sera incorrecte jusqu'à ce que les lightmaps soient re-calculées, auquel cas la valeur définie ici est supprimée puisque la ressource LightmapGIData entière est remplacée par le lightmapper.