stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_omnilight3d.rst
+70 -38
View File
@@ -14,92 +14,124 @@ OmniLight3D
Omnidirectional light, such as a light bulb or a candle.
.. rst-class:: classref-introduction-group
Description
-----------
An Omnidirectional light is a type of :ref:`Light3D<class_Light3D>` that emits light in all directions. The light is attenuated by distance and this attenuation can be configured by changing its energy, radius, and attenuation parameters.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`3D lights and shadows <../tutorials/3d/lights_and_shadows>`
.. rst-class:: classref-reftable-group
Properties
----------
+------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`omni_attenuation<class_OmniLight3D_property_omni_attenuation>` | ``1.0`` |
+------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`omni_range<class_OmniLight3D_property_omni_range>` | ``5.0`` |
+------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`ShadowMode<enum_OmniLight3D_ShadowMode>` | :ref:`omni_shadow_mode<class_OmniLight3D_property_omni_shadow_mode>` | ``1`` |
+------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | shadow_bias | ``0.2`` (overrides :ref:`Light3D<class_Light3D_property_shadow_bias>`) |
+------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------+
.. table::
:widths: auto
+------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`omni_attenuation<class_OmniLight3D_property_omni_attenuation>` | ``1.0`` |
+------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`omni_range<class_OmniLight3D_property_omni_range>` | ``5.0`` |
+------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`ShadowMode<enum_OmniLight3D_ShadowMode>` | :ref:`omni_shadow_mode<class_OmniLight3D_property_omni_shadow_mode>` | ``1`` |
+------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | shadow_bias | ``0.2`` (overrides :ref:`Light3D<class_Light3D_property_shadow_bias>`) |
+------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_OmniLight3D_ShadowMode:
.. _class_OmniLight3D_constant_SHADOW_DUAL_PARABOLOID:
.. _class_OmniLight3D_constant_SHADOW_CUBE:
.. rst-class:: classref-enumeration
enum **ShadowMode**:
- **SHADOW_DUAL_PARABOLOID** = **0** --- Shadows are rendered to a dual-paraboloid texture. Faster than :ref:`SHADOW_CUBE<class_OmniLight3D_constant_SHADOW_CUBE>`, but lower-quality.
.. _class_OmniLight3D_constant_SHADOW_DUAL_PARABOLOID:
- **SHADOW_CUBE** = **1** --- Shadows are rendered to a cubemap. Slower than :ref:`SHADOW_DUAL_PARABOLOID<class_OmniLight3D_constant_SHADOW_DUAL_PARABOLOID>`, but higher-quality.
.. rst-class:: classref-enumeration-constant
:ref:`ShadowMode<enum_OmniLight3D_ShadowMode>` **SHADOW_DUAL_PARABOLOID** = ``0``
Shadows are rendered to a dual-paraboloid texture. Faster than :ref:`SHADOW_CUBE<class_OmniLight3D_constant_SHADOW_CUBE>`, but lower-quality.
.. _class_OmniLight3D_constant_SHADOW_CUBE:
.. rst-class:: classref-enumeration-constant
:ref:`ShadowMode<enum_OmniLight3D_ShadowMode>` **SHADOW_CUBE** = ``1``
Shadows are rendered to a cubemap. Slower than :ref:`SHADOW_DUAL_PARABOLOID<class_OmniLight3D_constant_SHADOW_DUAL_PARABOLOID>`, but higher-quality.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_OmniLight3D_property_omni_attenuation:
- :ref:`float<class_float>` **omni_attenuation**
.. rst-class:: classref-property
+-----------+------------------+
| *Default* | ``1.0`` |
+-----------+------------------+
| *Setter* | set_param(value) |
+-----------+------------------+
| *Getter* | get_param() |
+-----------+------------------+
:ref:`float<class_float>` **omni_attenuation** = ``1.0``
.. rst-class:: classref-property-setget
- void **set_param** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_param** **(** **)**
The light's attenuation (drop-off) curve. A number of presets are available in the **Inspector** by right-clicking the curve.
.. rst-class:: classref-item-separator
----
.. _class_OmniLight3D_property_omni_range:
- :ref:`float<class_float>` **omni_range**
.. rst-class:: classref-property
+-----------+------------------+
| *Default* | ``5.0`` |
+-----------+------------------+
| *Setter* | set_param(value) |
+-----------+------------------+
| *Getter* | get_param() |
+-----------+------------------+
:ref:`float<class_float>` **omni_range** = ``5.0``
.. rst-class:: classref-property-setget
- void **set_param** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_param** **(** **)**
The light's radius. Note that the effectively lit area may appear to be smaller depending on the :ref:`omni_attenuation<class_OmniLight3D_property_omni_attenuation>` in use. No matter the :ref:`omni_attenuation<class_OmniLight3D_property_omni_attenuation>` in use, the light will never reach anything outside this radius.
\ **Note:** :ref:`omni_range<class_OmniLight3D_property_omni_range>` is not affected by :ref:`Node3D.scale<class_Node3D_property_scale>` (the light's scale or its parent's scale).
.. rst-class:: classref-item-separator
----
.. _class_OmniLight3D_property_omni_shadow_mode:
- :ref:`ShadowMode<enum_OmniLight3D_ShadowMode>` **omni_shadow_mode**
.. rst-class:: classref-property
+-----------+------------------------+
| *Default* | ``1`` |
+-----------+------------------------+
| *Setter* | set_shadow_mode(value) |
+-----------+------------------------+
| *Getter* | get_shadow_mode() |
+-----------+------------------------+
:ref:`ShadowMode<enum_OmniLight3D_ShadowMode>` **omni_shadow_mode** = ``1``
.. rst-class:: classref-property-setget
- void **set_shadow_mode** **(** :ref:`ShadowMode<enum_OmniLight3D_ShadowMode>` value **)**
- :ref:`ShadowMode<enum_OmniLight3D_ShadowMode>` **get_shadow_mode** **(** **)**
See :ref:`ShadowMode<enum_OmniLight3D_ShadowMode>`.