godot-docs/classes/class_light3d.rst

:github_url: hide

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

.. _class_Light3D:

Light3D
=======

**Inherits:** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`DirectionalLight3D<class_DirectionalLight3D>`, :ref:`OmniLight3D<class_OmniLight3D>`, :ref:`SpotLight3D<class_SpotLight3D>`

Provides a base class for different kinds of light nodes.

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

Light3D is the *abstract* base class for light nodes. As it can't be instantiated, it shouldn't be used directly. Other types of light nodes inherit from it. Light3D contains the common variables and parameters used for lighting.

Tutorials
---------

- :doc:`3D lights and shadows <../tutorials/3d/lights_and_shadows>`

- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__

Properties
----------

+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>`                | :ref:`editor_only<class_Light3D_property_editor_only>`                             | ``false``             |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>`              | :ref:`light_angular_distance<class_Light3D_property_light_angular_distance>`       | ``0.0``               |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`BakeMode<enum_Light3D_BakeMode>` | :ref:`light_bake_mode<class_Light3D_property_light_bake_mode>`                     | ``1``                 |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`Color<class_Color>`              | :ref:`light_color<class_Light3D_property_light_color>`                             | ``Color(1, 1, 1, 1)`` |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`int<class_int>`                  | :ref:`light_cull_mask<class_Light3D_property_light_cull_mask>`                     | ``4294967295``        |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>`              | :ref:`light_energy<class_Light3D_property_light_energy>`                           | ``1.0``               |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>`              | :ref:`light_indirect_energy<class_Light3D_property_light_indirect_energy>`         | ``1.0``               |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>`                | :ref:`light_negative<class_Light3D_property_light_negative>`                       | ``false``             |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`Texture2D<class_Texture2D>`      | :ref:`light_projector<class_Light3D_property_light_projector>`                     |                       |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>`              | :ref:`light_size<class_Light3D_property_light_size>`                               | ``0.0``               |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>`              | :ref:`light_specular<class_Light3D_property_light_specular>`                       | ``0.5``               |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>`              | :ref:`shadow_bias<class_Light3D_property_shadow_bias>`                             | ``0.2``               |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>`              | :ref:`shadow_blur<class_Light3D_property_shadow_blur>`                             | ``1.0``               |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`Color<class_Color>`              | :ref:`shadow_color<class_Light3D_property_shadow_color>`                           | ``Color(0, 0, 0, 1)`` |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>`                | :ref:`shadow_enabled<class_Light3D_property_shadow_enabled>`                       | ``false``             |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>`              | :ref:`shadow_fog_fade<class_Light3D_property_shadow_fog_fade>`                     | ``0.1``               |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>`              | :ref:`shadow_normal_bias<class_Light3D_property_shadow_normal_bias>`               | ``1.0``               |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>`                | :ref:`shadow_reverse_cull_face<class_Light3D_property_shadow_reverse_cull_face>`   | ``false``             |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>`              | :ref:`shadow_transmittance_bias<class_Light3D_property_shadow_transmittance_bias>` | ``0.05``              |
+----------------------------------------+------------------------------------------------------------------------------------+-----------------------+

Methods
-------

+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_Light3D_method_get_param>` **(** :ref:`Param<enum_Light3D_Param>` param **)** |const|                          |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`set_param<class_Light3D_method_set_param>` **(** :ref:`Param<enum_Light3D_Param>` param, :ref:`float<class_float>` value **)** |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+

Enumerations
------------

.. _enum_Light3D_Param:

.. _class_Light3D_constant_PARAM_ENERGY:

.. _class_Light3D_constant_PARAM_INDIRECT_ENERGY:

.. _class_Light3D_constant_PARAM_SPECULAR:

.. _class_Light3D_constant_PARAM_RANGE:

.. _class_Light3D_constant_PARAM_SIZE:

.. _class_Light3D_constant_PARAM_ATTENUATION:

.. _class_Light3D_constant_PARAM_SPOT_ANGLE:

.. _class_Light3D_constant_PARAM_SPOT_ATTENUATION:

.. _class_Light3D_constant_PARAM_SHADOW_MAX_DISTANCE:

.. _class_Light3D_constant_PARAM_SHADOW_SPLIT_1_OFFSET:

.. _class_Light3D_constant_PARAM_SHADOW_SPLIT_2_OFFSET:

.. _class_Light3D_constant_PARAM_SHADOW_SPLIT_3_OFFSET:

.. _class_Light3D_constant_PARAM_SHADOW_FADE_START:

.. _class_Light3D_constant_PARAM_SHADOW_NORMAL_BIAS:

.. _class_Light3D_constant_PARAM_SHADOW_BIAS:

.. _class_Light3D_constant_PARAM_SHADOW_PANCAKE_SIZE:

.. _class_Light3D_constant_PARAM_SHADOW_BLUR:

.. _class_Light3D_constant_PARAM_SHADOW_VOLUMETRIC_FOG_FADE:

.. _class_Light3D_constant_PARAM_TRANSMITTANCE_BIAS:

.. _class_Light3D_constant_PARAM_MAX:

enum **Param**:

- **PARAM_ENERGY** = **0** --- Constant for accessing :ref:`light_energy<class_Light3D_property_light_energy>`.

- **PARAM_INDIRECT_ENERGY** = **1** --- Constant for accessing :ref:`light_indirect_energy<class_Light3D_property_light_indirect_energy>`.

- **PARAM_SPECULAR** = **2** --- Constant for accessing :ref:`light_specular<class_Light3D_property_light_specular>`.

- **PARAM_RANGE** = **3** --- Constant for accessing :ref:`OmniLight3D.omni_range<class_OmniLight3D_property_omni_range>` or :ref:`SpotLight3D.spot_range<class_SpotLight3D_property_spot_range>`.

- **PARAM_SIZE** = **4** --- Constant for accessing :ref:`light_size<class_Light3D_property_light_size>`.

- **PARAM_ATTENUATION** = **5** --- Constant for accessing :ref:`OmniLight3D.omni_attenuation<class_OmniLight3D_property_omni_attenuation>` or :ref:`SpotLight3D.spot_attenuation<class_SpotLight3D_property_spot_attenuation>`.

- **PARAM_SPOT_ANGLE** = **6** --- Constant for accessing :ref:`SpotLight3D.spot_angle<class_SpotLight3D_property_spot_angle>`.

- **PARAM_SPOT_ATTENUATION** = **7** --- Constant for accessing :ref:`SpotLight3D.spot_angle_attenuation<class_SpotLight3D_property_spot_angle_attenuation>`.

- **PARAM_SHADOW_MAX_DISTANCE** = **8** --- Constant for accessing :ref:`DirectionalLight3D.directional_shadow_max_distance<class_DirectionalLight3D_property_directional_shadow_max_distance>`.

- **PARAM_SHADOW_SPLIT_1_OFFSET** = **9** --- Constant for accessing :ref:`DirectionalLight3D.directional_shadow_split_1<class_DirectionalLight3D_property_directional_shadow_split_1>`.

- **PARAM_SHADOW_SPLIT_2_OFFSET** = **10** --- Constant for accessing :ref:`DirectionalLight3D.directional_shadow_split_2<class_DirectionalLight3D_property_directional_shadow_split_2>`.

- **PARAM_SHADOW_SPLIT_3_OFFSET** = **11** --- Constant for accessing :ref:`DirectionalLight3D.directional_shadow_split_3<class_DirectionalLight3D_property_directional_shadow_split_3>`.

- **PARAM_SHADOW_FADE_START** = **12** --- Constant for accessing :ref:`DirectionalLight3D.directional_shadow_fade_start<class_DirectionalLight3D_property_directional_shadow_fade_start>`.

- **PARAM_SHADOW_NORMAL_BIAS** = **13** --- Constant for accessing :ref:`shadow_normal_bias<class_Light3D_property_shadow_normal_bias>`.

- **PARAM_SHADOW_BIAS** = **14** --- Constant for accessing :ref:`shadow_bias<class_Light3D_property_shadow_bias>`.

- **PARAM_SHADOW_PANCAKE_SIZE** = **15** --- Constant for accessing :ref:`DirectionalLight3D.directional_shadow_pancake_size<class_DirectionalLight3D_property_directional_shadow_pancake_size>`.

- **PARAM_SHADOW_BLUR** = **16** --- Constant for accessing :ref:`shadow_blur<class_Light3D_property_shadow_blur>`.

- **PARAM_SHADOW_VOLUMETRIC_FOG_FADE** = **17**

- **PARAM_TRANSMITTANCE_BIAS** = **18** --- Constant for accessing :ref:`shadow_transmittance_bias<class_Light3D_property_shadow_transmittance_bias>`.

- **PARAM_MAX** = **19** --- Represents the size of the :ref:`Param<enum_Light3D_Param>` enum.

----

.. _enum_Light3D_BakeMode:

.. _class_Light3D_constant_BAKE_DISABLED:

.. _class_Light3D_constant_BAKE_DYNAMIC:

.. _class_Light3D_constant_BAKE_STATIC:

enum **BakeMode**:

- **BAKE_DISABLED** = **0** --- Light is ignored when baking.

**Note:** Hiding a light does *not* affect baking.

- **BAKE_DYNAMIC** = **1**

- **BAKE_STATIC** = **2**

Property Descriptions
---------------------

.. _class_Light3D_property_editor_only:

- :ref:`bool<class_bool>` **editor_only**

+-----------+------------------------+
| *Default* | ``false``              |
+-----------+------------------------+
| *Setter*  | set_editor_only(value) |
+-----------+------------------------+
| *Getter*  | is_editor_only()       |
+-----------+------------------------+

If ``true``, the light only appears in the editor and will not be visible at runtime.

----

.. _class_Light3D_property_light_angular_distance:

- :ref:`float<class_float>` **light_angular_distance**

+-----------+------------------+
| *Default* | ``0.0``          |
+-----------+------------------+
| *Setter*  | set_param(value) |
+-----------+------------------+
| *Getter*  | get_param()      |
+-----------+------------------+

The light's angular size in degrees. Increasing this will make shadows softer at greater distances. Only available for :ref:`DirectionalLight3D<class_DirectionalLight3D>`\ s. For reference, the Sun from the Earth is approximately ``0.5``.

----

.. _class_Light3D_property_light_bake_mode:

- :ref:`BakeMode<enum_Light3D_BakeMode>` **light_bake_mode**

+-----------+----------------------+
| *Default* | ``1``                |
+-----------+----------------------+
| *Setter*  | set_bake_mode(value) |
+-----------+----------------------+
| *Getter*  | get_bake_mode()      |
+-----------+----------------------+

The light's bake mode. See :ref:`BakeMode<enum_Light3D_BakeMode>`.

----

.. _class_Light3D_property_light_color:

- :ref:`Color<class_Color>` **light_color**

+-----------+-----------------------+
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+
| *Setter*  | set_color(value)      |
+-----------+-----------------------+
| *Getter*  | get_color()           |
+-----------+-----------------------+

The light's color. An *overbright* color can be used to achieve a result equivalent to increasing the light's :ref:`light_energy<class_Light3D_property_light_energy>`.

----

.. _class_Light3D_property_light_cull_mask:

- :ref:`int<class_int>` **light_cull_mask**

+-----------+----------------------+
| *Default* | ``4294967295``       |
+-----------+----------------------+
| *Setter*  | set_cull_mask(value) |
+-----------+----------------------+
| *Getter*  | get_cull_mask()      |
+-----------+----------------------+

The light will affect objects in the selected layers.

----

.. _class_Light3D_property_light_energy:

- :ref:`float<class_float>` **light_energy**

+-----------+------------------+
| *Default* | ``1.0``          |
+-----------+------------------+
| *Setter*  | set_param(value) |
+-----------+------------------+
| *Getter*  | get_param()      |
+-----------+------------------+

The light's strength multiplier (this is not a physical unit). For :ref:`OmniLight3D<class_OmniLight3D>` and :ref:`SpotLight3D<class_SpotLight3D>`, changing this value will only change the light color's intensity, not the light's radius.

----

.. _class_Light3D_property_light_indirect_energy:

- :ref:`float<class_float>` **light_indirect_energy**

+-----------+------------------+
| *Default* | ``1.0``          |
+-----------+------------------+
| *Setter*  | set_param(value) |
+-----------+------------------+
| *Getter*  | get_param()      |
+-----------+------------------+

Secondary multiplier used with indirect light (light bounces). Used with :ref:`VoxelGI<class_VoxelGI>` and SDFGI (see :ref:`Environment.sdfgi_enabled<class_Environment_property_sdfgi_enabled>`).

**Note:** This property is ignored if :ref:`light_energy<class_Light3D_property_light_energy>` is equal to ``0.0``, as the light won't be present at all in the GI shader.

----

.. _class_Light3D_property_light_negative:

- :ref:`bool<class_bool>` **light_negative**

+-----------+---------------------+
| *Default* | ``false``           |
+-----------+---------------------+
| *Setter*  | set_negative(value) |
+-----------+---------------------+
| *Getter*  | is_negative()       |
+-----------+---------------------+

If ``true``, the light's effect is reversed, darkening areas and casting bright shadows.

----

.. _class_Light3D_property_light_projector:

- :ref:`Texture2D<class_Texture2D>` **light_projector**

+----------+----------------------+
| *Setter* | set_projector(value) |
+----------+----------------------+
| *Getter* | get_projector()      |
+----------+----------------------+

:ref:`Texture2D<class_Texture2D>` projected by light. :ref:`shadow_enabled<class_Light3D_property_shadow_enabled>` must be on for the projector to work. Light projectors make the light appear as if it is shining through a colored but transparent object, almost like light shining through stained-glass.

----

.. _class_Light3D_property_light_size:

- :ref:`float<class_float>` **light_size**

+-----------+------------------+
| *Default* | ``0.0``          |
+-----------+------------------+
| *Setter*  | set_param(value) |
+-----------+------------------+
| *Getter*  | get_param()      |
+-----------+------------------+

The size of the light in Godot units. Only available for :ref:`OmniLight3D<class_OmniLight3D>`\ s and :ref:`SpotLight3D<class_SpotLight3D>`\ s. Increasing this value will make the light fade out slower and shadows appear blurrier. This can be used to simulate area lights to an extent.

----

.. _class_Light3D_property_light_specular:

- :ref:`float<class_float>` **light_specular**

+-----------+------------------+
| *Default* | ``0.5``          |
+-----------+------------------+
| *Setter*  | set_param(value) |
+-----------+------------------+
| *Getter*  | get_param()      |
+-----------+------------------+

The intensity of the specular blob in objects affected by the light. At ``0``, the light becomes a pure diffuse light. When not baking emission, this can be used to avoid unrealistic reflections when placing lights above an emissive surface.

----

.. _class_Light3D_property_shadow_bias:

- :ref:`float<class_float>` **shadow_bias**

+-----------+------------------+
| *Default* | ``0.2``          |
+-----------+------------------+
| *Setter*  | set_param(value) |
+-----------+------------------+
| *Getter*  | get_param()      |
+-----------+------------------+

Used to adjust shadow appearance. Too small a value results in self-shadowing ("shadow acne"), while too large a value causes shadows to separate from casters ("peter-panning"). Adjust as needed.

----

.. _class_Light3D_property_shadow_blur:

- :ref:`float<class_float>` **shadow_blur**

+-----------+------------------+
| *Default* | ``1.0``          |
+-----------+------------------+
| *Setter*  | set_param(value) |
+-----------+------------------+
| *Getter*  | get_param()      |
+-----------+------------------+

Blurs the edges of the shadow. Can be used to hide pixel artifacts in low-resolution shadow maps. A high value can impact performance, make shadows appear grainy and can cause other unwanted artifacts. Try to keep as near default as possible.

----

.. _class_Light3D_property_shadow_color:

- :ref:`Color<class_Color>` **shadow_color**

+-----------+-------------------------+
| *Default* | ``Color(0, 0, 0, 1)``   |
+-----------+-------------------------+
| *Setter*  | set_shadow_color(value) |
+-----------+-------------------------+
| *Getter*  | get_shadow_color()      |
+-----------+-------------------------+

The color of shadows cast by this light.

----

.. _class_Light3D_property_shadow_enabled:

- :ref:`bool<class_bool>` **shadow_enabled**

+-----------+-------------------+
| *Default* | ``false``         |
+-----------+-------------------+
| *Setter*  | set_shadow(value) |
+-----------+-------------------+
| *Getter*  | has_shadow()      |
+-----------+-------------------+

If ``true``, the light will cast shadows.

----

.. _class_Light3D_property_shadow_fog_fade:

- :ref:`float<class_float>` **shadow_fog_fade**

+-----------+------------------+
| *Default* | ``0.1``          |
+-----------+------------------+
| *Setter*  | set_param(value) |
+-----------+------------------+
| *Getter*  | get_param()      |
+-----------+------------------+

----

.. _class_Light3D_property_shadow_normal_bias:

- :ref:`float<class_float>` **shadow_normal_bias**

+-----------+------------------+
| *Default* | ``1.0``          |
+-----------+------------------+
| *Setter*  | set_param(value) |
+-----------+------------------+
| *Getter*  | get_param()      |
+-----------+------------------+

Offsets the lookup into the shadow map by the object's normal. This can be used to reduce self-shadowing artifacts without using :ref:`shadow_bias<class_Light3D_property_shadow_bias>`. In practice, this value should be tweaked along with :ref:`shadow_bias<class_Light3D_property_shadow_bias>` to reduce artifacts as much as possible.

----

.. _class_Light3D_property_shadow_reverse_cull_face:

- :ref:`bool<class_bool>` **shadow_reverse_cull_face**

+-----------+-------------------------------------+
| *Default* | ``false``                           |
+-----------+-------------------------------------+
| *Setter*  | set_shadow_reverse_cull_face(value) |
+-----------+-------------------------------------+
| *Getter*  | get_shadow_reverse_cull_face()      |
+-----------+-------------------------------------+

If ``true``, reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double-sided shadows with :ref:`GeometryInstance3D.SHADOW_CASTING_SETTING_DOUBLE_SIDED<class_GeometryInstance3D_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED>`.

----

.. _class_Light3D_property_shadow_transmittance_bias:

- :ref:`float<class_float>` **shadow_transmittance_bias**

+-----------+------------------+
| *Default* | ``0.05``         |
+-----------+------------------+
| *Setter*  | set_param(value) |
+-----------+------------------+
| *Getter*  | get_param()      |
+-----------+------------------+

Method Descriptions
-------------------

.. _class_Light3D_method_get_param:

- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_Light3D_Param>` param **)** |const|

Returns the value of the specified :ref:`Param<enum_Light3D_Param>` parameter.

----

.. _class_Light3D_method_set_param:

- void **set_param** **(** :ref:`Param<enum_Light3D_Param>` param, :ref:`float<class_float>` value **)**

Sets the value of the specified :ref:`Param<enum_Light3D_Param>` parameter.

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