Light2D¶
Inherits: Node2D < CanvasItem < Node < Object
Inherited By: DirectionalLight2D, PointLight2D
Casts light in a 2D environment.
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: Light2D can also be used as a mask.
Tutorials¶
Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Methods¶
get_height ( ) const |
|
void |
set_height ( float height ) |
Enumerations¶
enum ShadowFilter:
SHADOW_FILTER_NONE = 0 --- No filter applies to the shadow map. See shadow_filter.
SHADOW_FILTER_PCF5 = 1 --- Percentage closer filtering (5 samples) applies to the shadow map. See shadow_filter.
SHADOW_FILTER_PCF13 = 2 --- Percentage closer filtering (13 samples) applies to the shadow map. See shadow_filter.
enum BlendMode:
BLEND_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.
BLEND_MODE_SUB = 1 --- Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect.
BLEND_MODE_MIX = 2 --- Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation.
Property Descriptions¶
BlendMode blend_mode
Default |
|
Setter |
set_blend_mode(value) |
Getter |
get_blend_mode() |
The Light2D's blend mode. See BlendMode constants for values.
Color color
Default |
|
Setter |
set_color(value) |
Getter |
get_color() |
The Light2D's Color.
bool editor_only
Default |
|
Setter |
set_editor_only(value) |
Getter |
is_editor_only() |
If true, Light2D will only appear when editing the scene.
bool enabled
Default |
|
Setter |
set_enabled(value) |
Getter |
is_enabled() |
If true, Light2D will emit light.
float energy
Default |
|
Setter |
set_energy(value) |
Getter |
get_energy() |
The Light2D's energy value. The larger the value, the stronger the light.
int range_item_cull_mask
Default |
|
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
Default |
|
Setter |
set_layer_range_max(value) |
Getter |
get_layer_range_max() |
Maximum layer value of objects that are affected by the Light2D.
int range_layer_min
Default |
|
Setter |
set_layer_range_min(value) |
Getter |
get_layer_range_min() |
Minimum layer value of objects that are affected by the Light2D.
int range_z_max
Default |
|
Setter |
set_z_range_max(value) |
Getter |
get_z_range_max() |
Maximum z value of objects that are affected by the Light2D.
int range_z_min
Default |
|
Setter |
set_z_range_min(value) |
Getter |
get_z_range_min() |
Minimum z value of objects that are affected by the Light2D.
Color shadow_color
Default |
|
Setter |
set_shadow_color(value) |
Getter |
get_shadow_color() |
Color of shadows cast by the Light2D.
bool shadow_enabled
Default |
|
Setter |
set_shadow_enabled(value) |
Getter |
is_shadow_enabled() |
If true, the Light2D will cast shadows.
ShadowFilter shadow_filter
Default |
|
Setter |
set_shadow_filter(value) |
Getter |
get_shadow_filter() |
Shadow filter type. See ShadowFilter for possible values.
float shadow_filter_smooth
Default |
|
Setter |
set_shadow_smooth(value) |
Getter |
get_shadow_smooth() |
Smoothing value for shadows.
int shadow_item_cull_mask
Default |
|
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 light mask will cast shadows.