.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the LightOccluder2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_LightOccluder2D:

LightOccluder2D
===============

**Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

Occludes light cast by a Light2D, casting shadows.

Member Variables
----------------

  .. _class_LightOccluder2D_light_mask:

- :ref:`int<class_int>` **light_mask** - The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s).

  .. _class_LightOccluder2D_occluder:

- :ref:`OccluderPolygon2D<class_occluderpolygon2d>` **occluder** - The :ref:`OccluderPolygon2D<class_occluderpolygon2d>` used to compute the shadow.


Description
-----------

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