Light2D

Light2D

Inherits: Node2D < CanvasItem < Node < Object

Category: Core

Brief Description

Casts light in a 2D environment.

Properties

Color	color
bool	editor_only
bool	enabled
float	energy
Mode	mode
Vector2	offset
float	range_height
int	range_item_cull_mask
int	range_layer_max
int	range_layer_min
int	range_z_max
int	range_z_min
int	shadow_buffer_size
Color	shadow_color
bool	shadow_enabled
ShadowFilter	shadow_filter
float	shadow_filter_smooth
float	shadow_gradient_length
int	shadow_item_cull_mask
Texture	texture
float	texture_scale

Enumerations

enum Mode:

MODE_ADD = 0 — Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behavior of a light.
MODE_SUB = 1 — Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect.
MODE_MIX = 2 — Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation.
MODE_MASK = 3 — The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture.

enum ShadowFilter:

SHADOW_FILTER_NONE = 0 — No filter applies to the shadow map. See shadow_filter.
SHADOW_FILTER_PCF3 = 1 — Percentage closer filtering (3 samples) applies to the shadow map. See shadow_filter.
SHADOW_FILTER_PCF5 = 2 — Percentage closer filtering (5 samples) applies to the shadow map. See shadow_filter.
SHADOW_FILTER_PCF7 = 3 — Percentage closer filtering (7 samples) applies to the shadow map. See shadow_filter.
SHADOW_FILTER_PCF9 = 4 — Percentage closer filtering (9 samples) applies to the shadow map. See shadow_filter.
SHADOW_FILTER_PCF13 = 5 — Percentage closer filtering (13 samples) applies to the shadow map. See shadow_filter.

Description

Casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask.

Tutorials

2D lights and shadows

Property Descriptions

Color color

Setter	set_color(value)
Getter	get_color()

The Light2D’s Color.

bool editor_only

Setter	set_editor_only(value)
Getter	is_editor_only()

If true, Light2D will only appear when editing the scene. Default value: false.

bool enabled

Setter	set_enabled(value)
Getter	is_enabled()

If true, Light2D will emit light. Default value: true.

float energy

Setter	set_energy(value)
Getter	get_energy()

The Light2D’s energy value. The larger the value, the stronger the light.

Mode mode

Setter	set_mode(value)
Getter	get_mode()

The Light2D’s mode. See MODE_* constants for values.

Vector2 offset

Setter	set_texture_offset(value)
Getter	get_texture_offset()

The offset of the Light2D’s texture.

float range_height

Setter	set_height(value)
Getter	get_height()

The height of the Light2D. Used with 2D normal mapping.

int range_item_cull_mask

Setter	set_item_cull_mask(value)
Getter	get_item_cull_mask()

The layer mask. Only objects with a matching mask will be affected by the Light2D.

int range_layer_max

Setter	set_layer_range_max(value)
Getter	get_layer_range_max()

Maximum layer value of objects that are affected by the Light2D. Default value: 0.

int range_layer_min

Setter	set_layer_range_min(value)
Getter	get_layer_range_min()

Minimum layer value of objects that are affected by the Light2D. Default value: 0.

int range_z_max

Setter	set_z_range_max(value)
Getter	get_z_range_max()

Maximum z value of objects that are affected by the Light2D. Default value: 1024.

int range_z_min

Setter	set_z_range_min(value)
Getter	get_z_range_min()

Minimum z value of objects that are affected by the Light2D. Default value: -1024.

int shadow_buffer_size

Setter	set_shadow_buffer_size(value)
Getter	get_shadow_buffer_size()

Shadow buffer size. Default value: 2048.

Color shadow_color

Setter	set_shadow_color(value)
Getter	get_shadow_color()

Color of shadows cast by the Light2D.

bool shadow_enabled

Setter	set_shadow_enabled(value)
Getter	is_shadow_enabled()

If true, the Light2D will cast shadows. Default value: false.

ShadowFilter shadow_filter

Setter	set_shadow_filter(value)
Getter	get_shadow_filter()

Shadow filter type. Use ShadowFilter constants as values. Default value: SHADOW_FILTER_NONE.

float shadow_filter_smooth

Setter	set_shadow_smooth(value)
Getter	get_shadow_smooth()

Smoothing value for shadows.

float shadow_gradient_length

Setter	set_shadow_gradient_length(value)
Getter	get_shadow_gradient_length()

Smooth shadow gradient length.

int shadow_item_cull_mask

Setter	set_item_shadow_cull_mask(value)
Getter	get_item_shadow_cull_mask()

The shadow mask. Used with LightOccluder2D to cast shadows. Only occluders with a matching shadow mask will cast shadows.

Texture texture

Setter	set_texture(value)
Getter	get_texture()

Texture used for the Light2D’s appearance.

float texture_scale

Setter	set_texture_scale(value)
Getter	get_texture_scale()

The texture’s scale factor.