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

Light2D

Hérite de : Node2D < CanvasItem < Node < Object

Hérité par : DirectionalLight2D, PointLight2D

Projette de la lumière dans un environnement 2D.

Description

Projette de la lumière dans un environnement 2D. Une lumière est définie avec une couleur, une valeur d'énergie, un mode (voir les constantes), et divers autres paramètres (concernant la portée et les ombres).

Tutoriels

Les lumières et ombres 2D

Propriétés

BlendMode	blend_mode	`0`
Color	color	`Color(1, 1, 1, 1)`
bool	editor_only	`false`
bool	enabled	`true`
float	energy	`1.0`
int	range_item_cull_mask	`1`
int	range_layer_max	`0`
int	range_layer_min	`0`
int	range_z_max	`1024`
int	range_z_min	`-1024`
Color	shadow_color	`Color(0, 0, 0, 0)`
bool	shadow_enabled	`false`
ShadowFilter	shadow_filter	`0`
float	shadow_filter_smooth	`0.0`
int	shadow_item_cull_mask	`1`

Méthodes

float	get_height() const
void	set_height(height: float)

Énumérations

enum ShadowFilter: 🔗

ShadowFilter SHADOW_FILTER_NONE = 0

Aucun filtre ne s'applique à la carte des ombres. Cela fournit des bords d'ombre nets et est le plus rapide à rendre. Voir shadow_filter.

ShadowFilter SHADOW_FILTER_PCF5 = 1

Percentage closer filtering (5 samples) applies to the shadow map. This is slower compared to hard shadow rendering. See shadow_filter.

ShadowFilter SHADOW_FILTER_PCF13 = 2

Percentage closer filtering (13 samples) applies to the shadow map. This is the slowest shadow filtering mode, and should be used sparingly. See shadow_filter.

enum BlendMode: 🔗

BlendMode BLEND_MODE_ADD = 0

Ajoute la valeur des pixels correspondant à la Light2D aux valeurs des pixels sous elle. C'est le comportement classique des lumières.

BlendMode BLEND_MODE_SUB = 1

Soustrait la valeur des pixels correspondant à la Light2D aux valeurs des pixels sous elle, ce qui entraîne un effet de lumière inversé.

BlendMode BLEND_MODE_MIX = 2

Mélange la valeur des pixels correspondant à la Light2D aux valeurs des pixels sous elle, via une interpolation linéaire.

Descriptions des propriétés

BlendMode blend_mode = 0 🔗

void set_blend_mode(value: BlendMode)
BlendMode get_blend_mode()

Le mode de mélange de la Light2D.

Color color = Color(1, 1, 1, 1) 🔗

void set_color(value: Color)
Color get_color()

La Color de Light2D.

bool editor_only = false 🔗

void set_editor_only(value: bool)
bool is_editor_only()

Si true, la Light2D n’apparaîtra que lors de l'édition de la scène.

bool enabled = true 🔗

void set_enabled(value: bool)
bool is_enabled()

Si true, la Light2D émettra de la lumière.

float energy = 1.0 🔗

void set_energy(value: float)
float get_energy()

L'énergie de la Light2D. Plus la valeur est élevée, plus la lumière est forte.

int range_item_cull_mask = 1 🔗

void set_item_cull_mask(value: int)
int get_item_cull_mask()

Le masque de couche. Seuls les objets ayant un CanvasItem.light_mask correspondant seront affectés par la Light2D. Voir aussi shadow_item_cull_mask, qui affecte les objets qui peuvent projeter des ombres.

Note : range_item_cull_mask est ignoré par DirectionalLight2D, qui illumine toujours un nœud 2D indépendamment du CanvasItem.light_mask du nœud 2D.

int range_layer_max = 0 🔗

void set_layer_range_max(value: int)
int get_layer_range_max()

La niveau de calque maximum pour qu'un objet soit éclairé par la Light2D.

int range_layer_min = 0 🔗

void set_layer_range_min(value: int)
int get_layer_range_min()

La niveau de calque minimum pour qu'un objet soit éclairé par la Light2D.

int range_z_max = 1024 🔗

void set_z_range_max(value: int)
int get_z_range_max()

La valeur z maximale pour que les objets soient affectés pour les Light2D.

int range_z_min = -1024 🔗

void set_z_range_min(value: int)
int get_z_range_min()

La valeur z minimale pour que les objets soient affectés pour les Light2D.

Color shadow_color = Color(0, 0, 0, 0) 🔗

void set_shadow_color(value: Color)
Color get_shadow_color()

La Color de l'ombre affichée par la Light2D.

bool shadow_enabled = false 🔗

void set_shadow_enabled(value: bool)
bool is_shadow_enabled()

Si true, la Light2D affichera les ombres.

ShadowFilter shadow_filter = 0 🔗

void set_shadow_filter(value: ShadowFilter)
ShadowFilter get_shadow_filter()

Type de filtrage des ombres.

float shadow_filter_smooth = 0.0 🔗

void set_shadow_smooth(value: float)
float get_shadow_smooth()

Valeur de lissage pour les ombres. Des valeurs plus élevées entraîneront des ombres plus douces, au prix de stries visibles qui peuvent apparaître dans le rendu des ombres. shadow_filter_smooth a seulement un effet si shadow_filter vaut SHADOW_FILTER_PCF5 ou SHADOW_FILTER_PCF13.

int shadow_item_cull_mask = 1 🔗

void set_item_shadow_cull_mask(value: int)
int get_item_shadow_cull_mask()

Le masque des ombres. Utilisé avec LightOccluder2D pour projeter des ombres. Seuls les occulteurs avec un masque de lumière CanvasItem.light_mask correspondant projetteront des ombres. Voir aussi range_item_cull_mask, qui affecte les objets qui peuvent recevoir la lumière.

Descriptions des méthodes

float get_height() const 🔗

Renvoie la hauteur de la lumière, qui est utilisée dans les normal maps 2D. Voir PointLight2D.height et DirectionalLight2D.height.

void set_height(height: float) 🔗

Définit la hauteur de la lumière, qui est utilisée dans les normal maps 2D. Voir PointLight2D.height et DirectionalLight2D.height.