Skip to content
Download
API reference

LightOccluder2D

Inherits: Spatial2D < CanvasItem < Actor < Object

Occludes light cast by a Light2D, casting shadows.

Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be provided with an OccluderPolygon2D in order for the shadow to be computed.

TypeNameDefault
OccluderPolygon2Doccluder
intoccluder_light_mask1
boolsdf_collisiontrue

OccluderPolygon2D occluder

Setter/getter: set_occluder_polygon(), get_occluder_polygon()

The OccluderPolygon2D used to compute the shadow.

int occluder_light_mask = 1

Setter/getter: set_occluder_light_mask(), get_occluder_light_mask()

The LightOccluder2D’s occluder light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s).

bool sdf_collision = true

Setter/getter: set_as_sdf_collision(), is_set_as_sdf_collision()

If enabled, the occluder will be part of a real-time generated signed distance field that can be used in custom shaders.