godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (17e7f85)

Browse Source
This commit is contained in:
Godot Organization
2024-01-27 03:18:33 +00:00
parent 515d22d2b4
commit fcfc613357
29 changed files with 837 additions and 495 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
classes/class_reflectionprobe.rst
View File

@@ -67,6 +67,8 @@ Properties
+------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`origin_offset<class_ReflectionProbe_property_origin_offset>` | ``Vector3(0, 0, 0)`` |
+------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+
| :ref:`int<class_int>` | :ref:`reflection_mask<class_ReflectionProbe_property_reflection_mask>` | ``1048575`` |
+------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`size<class_ReflectionProbe_property_size>` | ``Vector3(20, 20, 20)`` |
+------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+
| :ref:`UpdateMode<enum_ReflectionProbe_UpdateMode>` | :ref:`update_mode<class_ReflectionProbe_property_update_mode>` | ``0`` |
@@ -227,7 +229,9 @@ If ``true``, enables box projection. This makes reflections look more correct in
- void **set_cull_mask** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_cull_mask** **(** **)**
Sets the cull mask which determines what objects are drawn by this probe. Every :ref:`VisualInstance3D<class_VisualInstance3D>` with a layer included in this cull mask will be rendered by the probe. To improve performance, it is best to only include large objects which are likely to take up a lot of space in the reflection.
Sets the cull mask which determines what objects are drawn by this probe. Every :ref:`VisualInstance3D<class_VisualInstance3D>` with a layer included in this cull mask will be rendered by the probe. It is best to only include large objects which are likely to take up a lot of space in the reflection in order to save on rendering cost.
This can also be used to prevent an object from reflecting upon itself (for instance, a **ReflectionProbe** centered on a vehicle).
.. rst-class:: classref-item-separator
@@ -339,6 +343,23 @@ Sets the origin offset to be used when this **ReflectionProbe** is in :ref:`box_
----
.. _class_ReflectionProbe_property_reflection_mask:
.. rst-class:: classref-property
:ref:`int<class_int>` **reflection_mask** = ``1048575``
.. rst-class:: classref-property-setget
- void **set_reflection_mask** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_reflection_mask** **(** **)**
Sets the reflection mask which determines what objects have reflections applied from this probe. Every :ref:`VisualInstance3D<class_VisualInstance3D>` with a layer included in this reflection mask will have reflections applied from this probe. See also :ref:`cull_mask<class_ReflectionProbe_property_cull_mask>`, which can be used to exclude objects from appearing in the reflection while still making them affected by the **ReflectionProbe**.
.. rst-class:: classref-item-separator
----
.. _class_ReflectionProbe_property_size:
.. rst-class:: classref-property