| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/LightOccluder2D.xml.
- .. _class_LightOccluder2D:
- LightOccluder2D
- ===============
- **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- Occludes light cast by a Light2D, casting shadows.
- .. rst-class:: classref-introduction-group
- 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.
- .. rst-class:: classref-introduction-group
- Tutorials
- ---------
- - :doc:`2D lights and shadows <../tutorials/2d/2d_lights_and_shadows>`
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +---------------------------------------------------+--------------------------------------------------------------------------------+----------+
- | :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` | :ref:`occluder<class_LightOccluder2D_property_occluder>` | |
- +---------------------------------------------------+--------------------------------------------------------------------------------+----------+
- | :ref:`int<class_int>` | :ref:`occluder_light_mask<class_LightOccluder2D_property_occluder_light_mask>` | ``1`` |
- +---------------------------------------------------+--------------------------------------------------------------------------------+----------+
- | :ref:`bool<class_bool>` | :ref:`sdf_collision<class_LightOccluder2D_property_sdf_collision>` | ``true`` |
- +---------------------------------------------------+--------------------------------------------------------------------------------+----------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_LightOccluder2D_property_occluder:
- .. rst-class:: classref-property
- :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` **occluder**
- .. rst-class:: classref-property-setget
- - void **set_occluder_polygon** **(** :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` value **)**
- - :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` **get_occluder_polygon** **(** **)**
- The :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` used to compute the shadow.
- .. rst-class:: classref-item-separator
- ----
- .. _class_LightOccluder2D_property_occluder_light_mask:
- .. rst-class:: classref-property
- :ref:`int<class_int>` **occluder_light_mask** = ``1``
- .. rst-class:: classref-property-setget
- - void **set_occluder_light_mask** **(** :ref:`int<class_int>` value **)**
- - :ref:`int<class_int>` **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).
- .. rst-class:: classref-item-separator
- ----
- .. _class_LightOccluder2D_property_sdf_collision:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **sdf_collision** = ``true``
- .. rst-class:: classref-property-setget
- - void **set_as_sdf_collision** **(** :ref:`bool<class_bool>` value **)**
- - :ref:`bool<class_bool>` **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.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
- .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
