Class LightOccluder2D

Occludes light cast by a Light2D, casting shadows.

Inheritance

Node2D

CanvasItem

Node

Object

LightOccluder2D

Remarks

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

See Also

2D lights and shadows

Properties

occluder

The OccluderPolygon2D used to compute the shadow.

var occluder : OccluderPolygon2D

Property Value

OccluderPolygon2D

Remarks

• void set_occluder_polygon(OccluderPolygon2D value)
• OccluderPolygon2D get_occluder_polygon

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

var occluder_light_mask : int = 1

Property Value

int

Remarks

• void set_occluder_light_mask(int value)
• int get_occluder_light_mask

sdf_collision

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

var sdf_collision : bool = true

Property Value

bool

Remarks

• void set_as_sdf_collision(bool value)
• bool is_set_as_sdf_collision