Casts light in a 2D environment.
Casts light in a 2D environment. A light is defined as a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related).
The layer mask. Only objects with a matching CanvasItem.light_mask will be affected by the Light2D. See also shadow_item_cull_mask, which affects which objects can cast shadows.
Note: range_item_cull_mask is ignored by DirectionalLight2D, which will always light a 2D node regardless of the 2D node's CanvasItem.light_mask.
Smoothing value for shadows. Higher values will result in softer shadows, at the cost of visible streaks that can appear in shadow rendering. shadow_filter_smooth only has an effect if shadow_filter is SHADOW_FILTER_PCF5 or SHADOW_FILTER_PCF13.
The shadow mask. Used with LightOccluder2D to cast shadows. Only occluders with a matching CanvasItem.light_mask will cast shadows. See also range_item_cull_mask, which affects which objects can receive the light.
Returns the light's height, which is used in 2D normal mapping. See PointLight2D.height and DirectionalLight2D.height.
Sets the light's height, which is used in 2D normal mapping. See PointLight2D.height and DirectionalLight2D.height.
SHADOW_FILTER_NONE = 0No filter applies to the shadow map. This provides hard shadow edges and is the fastest to render. See shadow_filter.
SHADOW_FILTER_PCF5 = 1Percentage closer filtering (5 samples) applies to the shadow map. This is slower compared to hard shadow rendering. See shadow_filter.
SHADOW_FILTER_PCF13 = 2Percentage closer filtering (13 samples) applies to the shadow map. This is the slowest shadow filtering mode, and should be used sparingly. See shadow_filter.
BLEND_MODE_ADD = 0Adds 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 = 1Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect.
BLEND_MODE_MIX = 2Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation.