godot-docs/classes/class_reflectionprobe.rst

:github_url: hide

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

Captures its surroundings to create reflections.

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

Capture its surroundings as a dual parabolid image, and stores versions of it with increasing levels of blur to simulate different material roughnesses.

Tutorials
---------

- :doc:`../tutorials/3d/reflection_probes`

Properties
----------

+----------------------------------------------------+------------------------------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>`                            | :ref:`box_projection<class_ReflectionProbe_property_box_projection>`                     | ``false``               |
+----------------------------------------------------+------------------------------------------------------------------------------------------+-------------------------+
| :ref:`int<class_int>`                              | :ref:`cull_mask<class_ReflectionProbe_property_cull_mask>`                               | ``1048575``             |
+----------------------------------------------------+------------------------------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>`                            | :ref:`enable_shadows<class_ReflectionProbe_property_enable_shadows>`                     | ``false``               |
+----------------------------------------------------+------------------------------------------------------------------------------------------+-------------------------+
| :ref:`Vector3<class_Vector3>`                      | :ref:`extents<class_ReflectionProbe_property_extents>`                                   | ``Vector3( 1, 1, 1 )``  |
+----------------------------------------------------+------------------------------------------------------------------------------------------+-------------------------+
| :ref:`float<class_float>`                          | :ref:`intensity<class_ReflectionProbe_property_intensity>`                               | ``1.0``                 |
+----------------------------------------------------+------------------------------------------------------------------------------------------+-------------------------+
| :ref:`Color<class_Color>`                          | :ref:`interior_ambient_color<class_ReflectionProbe_property_interior_ambient_color>`     | ``Color( 0, 0, 0, 1 )`` |
+----------------------------------------------------+------------------------------------------------------------------------------------------+-------------------------+
| :ref:`float<class_float>`                          | :ref:`interior_ambient_contrib<class_ReflectionProbe_property_interior_ambient_contrib>` | ``0.0``                 |
+----------------------------------------------------+------------------------------------------------------------------------------------------+-------------------------+
| :ref:`float<class_float>`                          | :ref:`interior_ambient_energy<class_ReflectionProbe_property_interior_ambient_energy>`   | ``1.0``                 |
+----------------------------------------------------+------------------------------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>`                            | :ref:`interior_enable<class_ReflectionProbe_property_interior_enable>`                   | ``false``               |
+----------------------------------------------------+------------------------------------------------------------------------------------------+-------------------------+
| :ref:`float<class_float>`                          | :ref:`max_distance<class_ReflectionProbe_property_max_distance>`                         | ``0.0``                 |
+----------------------------------------------------+------------------------------------------------------------------------------------------+-------------------------+
| :ref:`Vector3<class_Vector3>`                      | :ref:`origin_offset<class_ReflectionProbe_property_origin_offset>`                       | ``Vector3( 0, 0, 0 )``  |
+----------------------------------------------------+------------------------------------------------------------------------------------------+-------------------------+
| :ref:`UpdateMode<enum_ReflectionProbe_UpdateMode>` | :ref:`update_mode<class_ReflectionProbe_property_update_mode>`                           | ``0``                   |
+----------------------------------------------------+------------------------------------------------------------------------------------------+-------------------------+

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

.. _enum_ReflectionProbe_UpdateMode:

.. _class_ReflectionProbe_constant_UPDATE_ONCE:

.. _class_ReflectionProbe_constant_UPDATE_ALWAYS:

enum **UpdateMode**:

- **UPDATE_ONCE** = **0**

- **UPDATE_ALWAYS** = **1**

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

.. _class_ReflectionProbe_property_box_projection:

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

+-----------+----------------------------------+
| *Default* | ``false``                        |
+-----------+----------------------------------+
| *Setter*  | set_enable_box_projection(value) |
+-----------+----------------------------------+
| *Getter*  | is_box_projection_enabled()      |
+-----------+----------------------------------+

If ``true``, enables box projection. This makes reflections look more correct in rectangle-shaped rooms by offsetting the reflection center depending on the camera's location.

----

.. _class_ReflectionProbe_property_cull_mask:

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

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

----

.. _class_ReflectionProbe_property_enable_shadows:

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

+-----------+---------------------------+
| *Default* | ``false``                 |
+-----------+---------------------------+
| *Setter*  | set_enable_shadows(value) |
+-----------+---------------------------+
| *Getter*  | are_shadows_enabled()     |
+-----------+---------------------------+

If ``true``, computes shadows in the reflection probe. This makes the reflection probe slower to render; you may want to disable this if using the :ref:`UPDATE_ALWAYS<class_ReflectionProbe_constant_UPDATE_ALWAYS>` :ref:`update_mode<class_ReflectionProbe_property_update_mode>`.

----

.. _class_ReflectionProbe_property_extents:

- :ref:`Vector3<class_Vector3>` **extents**

+-----------+------------------------+
| *Default* | ``Vector3( 1, 1, 1 )`` |
+-----------+------------------------+
| *Setter*  | set_extents(value)     |
+-----------+------------------------+
| *Getter*  | get_extents()          |
+-----------+------------------------+

----

.. _class_ReflectionProbe_property_intensity:

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

+-----------+----------------------+
| *Default* | ``1.0``              |
+-----------+----------------------+
| *Setter*  | set_intensity(value) |
+-----------+----------------------+
| *Getter*  | get_intensity()      |
+-----------+----------------------+

Defines the reflection intensity.

----

.. _class_ReflectionProbe_property_interior_ambient_color:

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

+-----------+-----------------------------+
| *Default* | ``Color( 0, 0, 0, 1 )``     |
+-----------+-----------------------------+
| *Setter*  | set_interior_ambient(value) |
+-----------+-----------------------------+
| *Getter*  | get_interior_ambient()      |
+-----------+-----------------------------+

----

.. _class_ReflectionProbe_property_interior_ambient_contrib:

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

+-----------+------------------------------------------------+
| *Default* | ``0.0``                                        |
+-----------+------------------------------------------------+
| *Setter*  | set_interior_ambient_probe_contribution(value) |
+-----------+------------------------------------------------+
| *Getter*  | get_interior_ambient_probe_contribution()      |
+-----------+------------------------------------------------+

----

.. _class_ReflectionProbe_property_interior_ambient_energy:

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

+-----------+------------------------------------+
| *Default* | ``1.0``                            |
+-----------+------------------------------------+
| *Setter*  | set_interior_ambient_energy(value) |
+-----------+------------------------------------+
| *Getter*  | get_interior_ambient_energy()      |
+-----------+------------------------------------+

----

.. _class_ReflectionProbe_property_interior_enable:

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

+-----------+------------------------+
| *Default* | ``false``              |
+-----------+------------------------+
| *Setter*  | set_as_interior(value) |
+-----------+------------------------+
| *Getter*  | is_set_as_interior()   |
+-----------+------------------------+

----

.. _class_ReflectionProbe_property_max_distance:

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

+-----------+-------------------------+
| *Default* | ``0.0``                 |
+-----------+-------------------------+
| *Setter*  | set_max_distance(value) |
+-----------+-------------------------+
| *Getter*  | get_max_distance()      |
+-----------+-------------------------+

----

.. _class_ReflectionProbe_property_origin_offset:

- :ref:`Vector3<class_Vector3>` **origin_offset**

+-----------+--------------------------+
| *Default* | ``Vector3( 0, 0, 0 )``   |
+-----------+--------------------------+
| *Setter*  | set_origin_offset(value) |
+-----------+--------------------------+
| *Getter*  | get_origin_offset()      |
+-----------+--------------------------+

----

.. _class_ReflectionProbe_property_update_mode:

- :ref:`UpdateMode<enum_ReflectionProbe_UpdateMode>` **update_mode**

+-----------+------------------------+
| *Default* | ``0``                  |
+-----------+------------------------+
| *Setter*  | set_update_mode(value) |
+-----------+------------------------+
| *Getter*  | get_update_mode()      |
+-----------+------------------------+