godot-docs/classes/class_reflectionprobe.rst

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

.. _class_ReflectionProbe:

ReflectionProbe
===============

**Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

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



Member Functions
----------------

+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`are_shadows_enabled<class_ReflectionProbe_are_shadows_enabled>`  **(** **)** const                                                                                         |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_cull_mask<class_ReflectionProbe_get_cull_mask>`  **(** **)** const                                                                                                     |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`  | :ref:`get_extents<class_ReflectionProbe_get_extents>`  **(** **)** const                                                                                                         |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_intensity<class_ReflectionProbe_get_intensity>`  **(** **)** const                                                                                                     |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`      | :ref:`get_interior_ambient<class_ReflectionProbe_get_interior_ambient>`  **(** **)** const                                                                                       |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_interior_ambient_energy<class_ReflectionProbe_get_interior_ambient_energy>`  **(** **)** const                                                                         |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_interior_ambient_probe_contribution<class_ReflectionProbe_get_interior_ambient_probe_contribution>`  **(** **)** const                                                 |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_max_distance<class_ReflectionProbe_get_max_distance>`  **(** **)** const                                                                                               |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`  | :ref:`get_origin_offset<class_ReflectionProbe_get_origin_offset>`  **(** **)** const                                                                                             |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_update_mode<class_ReflectionProbe_get_update_mode>`  **(** **)** const                                                                                                 |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_box_projection_enabled<class_ReflectionProbe_is_box_projection_enabled>`  **(** **)** const                                                                             |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_set_as_interior<class_ReflectionProbe_is_set_as_interior>`  **(** **)** const                                                                                           |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_as_interior<class_ReflectionProbe_set_as_interior>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                       |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_cull_mask<class_ReflectionProbe_set_cull_mask>`  **(** :ref:`int<class_int>` layers  **)**                                                                             |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_enable_box_projection<class_ReflectionProbe_set_enable_box_projection>`  **(** :ref:`bool<class_bool>` enable  **)**                                                   |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_enable_shadows<class_ReflectionProbe_set_enable_shadows>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                 |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_extents<class_ReflectionProbe_set_extents>`  **(** :ref:`Vector3<class_vector3>` extents  **)**                                                                        |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_intensity<class_ReflectionProbe_set_intensity>`  **(** :ref:`float<class_float>` intensity  **)**                                                                      |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_interior_ambient<class_ReflectionProbe_set_interior_ambient>`  **(** :ref:`Color<class_color>` ambient  **)**                                                          |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_interior_ambient_energy<class_ReflectionProbe_set_interior_ambient_energy>`  **(** :ref:`float<class_float>` ambient_energy  **)**                                     |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_interior_ambient_probe_contribution<class_ReflectionProbe_set_interior_ambient_probe_contribution>`  **(** :ref:`float<class_float>` ambient_probe_contribution  **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_max_distance<class_ReflectionProbe_set_max_distance>`  **(** :ref:`float<class_float>` max_distance  **)**                                                             |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_origin_offset<class_ReflectionProbe_set_origin_offset>`  **(** :ref:`Vector3<class_vector3>` origin_offset  **)**                                                      |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_update_mode<class_ReflectionProbe_set_update_mode>`  **(** :ref:`int<class_int>` mode  **)**                                                                           |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

- :ref:`bool<class_bool>` **box_projection**
- :ref:`int<class_int>` **cull_mask**
- :ref:`bool<class_bool>` **enable_shadows**
- :ref:`Vector3<class_vector3>` **extents**
- :ref:`float<class_float>` **intensity**
- :ref:`Color<class_color>` **interior_ambient_color**
- :ref:`float<class_float>` **interior_ambient_contrib**
- :ref:`float<class_float>` **interior_ambient_energy**
- :ref:`bool<class_bool>` **interior_enable**
- :ref:`float<class_float>` **max_distance**
- :ref:`Vector3<class_vector3>` **origin_offset**
- :ref:`int<class_int>` **update_mode**

Numeric Constants
-----------------

- **UPDATE_ONCE** = **0**
- **UPDATE_ALWAYS** = **1**

Member Function Description
---------------------------

.. _class_ReflectionProbe_are_shadows_enabled:

- :ref:`bool<class_bool>`  **are_shadows_enabled**  **(** **)** const

.. _class_ReflectionProbe_get_cull_mask:

- :ref:`int<class_int>`  **get_cull_mask**  **(** **)** const

.. _class_ReflectionProbe_get_extents:

- :ref:`Vector3<class_vector3>`  **get_extents**  **(** **)** const

.. _class_ReflectionProbe_get_intensity:

- :ref:`float<class_float>`  **get_intensity**  **(** **)** const

.. _class_ReflectionProbe_get_interior_ambient:

- :ref:`Color<class_color>`  **get_interior_ambient**  **(** **)** const

.. _class_ReflectionProbe_get_interior_ambient_energy:

- :ref:`float<class_float>`  **get_interior_ambient_energy**  **(** **)** const

.. _class_ReflectionProbe_get_interior_ambient_probe_contribution:

- :ref:`float<class_float>`  **get_interior_ambient_probe_contribution**  **(** **)** const

.. _class_ReflectionProbe_get_max_distance:

- :ref:`float<class_float>`  **get_max_distance**  **(** **)** const

.. _class_ReflectionProbe_get_origin_offset:

- :ref:`Vector3<class_vector3>`  **get_origin_offset**  **(** **)** const

.. _class_ReflectionProbe_get_update_mode:

- :ref:`int<class_int>`  **get_update_mode**  **(** **)** const

.. _class_ReflectionProbe_is_box_projection_enabled:

- :ref:`bool<class_bool>`  **is_box_projection_enabled**  **(** **)** const

.. _class_ReflectionProbe_is_set_as_interior:

- :ref:`bool<class_bool>`  **is_set_as_interior**  **(** **)** const

.. _class_ReflectionProbe_set_as_interior:

- void  **set_as_interior**  **(** :ref:`bool<class_bool>` enable  **)**

.. _class_ReflectionProbe_set_cull_mask:

- void  **set_cull_mask**  **(** :ref:`int<class_int>` layers  **)**

.. _class_ReflectionProbe_set_enable_box_projection:

- void  **set_enable_box_projection**  **(** :ref:`bool<class_bool>` enable  **)**

.. _class_ReflectionProbe_set_enable_shadows:

- void  **set_enable_shadows**  **(** :ref:`bool<class_bool>` enable  **)**

.. _class_ReflectionProbe_set_extents:

- void  **set_extents**  **(** :ref:`Vector3<class_vector3>` extents  **)**

.. _class_ReflectionProbe_set_intensity:

- void  **set_intensity**  **(** :ref:`float<class_float>` intensity  **)**

.. _class_ReflectionProbe_set_interior_ambient:

- void  **set_interior_ambient**  **(** :ref:`Color<class_color>` ambient  **)**

.. _class_ReflectionProbe_set_interior_ambient_energy:

- void  **set_interior_ambient_energy**  **(** :ref:`float<class_float>` ambient_energy  **)**

.. _class_ReflectionProbe_set_interior_ambient_probe_contribution:

- void  **set_interior_ambient_probe_contribution**  **(** :ref:`float<class_float>` ambient_probe_contribution  **)**

.. _class_ReflectionProbe_set_max_distance:

- void  **set_max_distance**  **(** :ref:`float<class_float>` max_distance  **)**

.. _class_ReflectionProbe_set_origin_offset:

- void  **set_origin_offset**  **(** :ref:`Vector3<class_vector3>` origin_offset  **)**

.. _class_ReflectionProbe_set_update_mode:

- void  **set_update_mode**  **(** :ref:`int<class_int>` mode  **)**