mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
2b4319bc29
Changes order of brief/long descriptions and removes category as per godotengine/godot#35132.
234 lines
7.9 KiB
ReStructuredText
234 lines
7.9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the GIProbe.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_GIProbe:
|
|
|
|
GIProbe
|
|
=======
|
|
|
|
**Inherits:** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/3d/gi_probes`
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------------------+------------------------------------------------------------+-----------------------+
|
|
| :ref:`float<class_float>` | :ref:`bias<class_GIProbe_property_bias>` | 1.5 |
|
|
+---------------------------------------+------------------------------------------------------------+-----------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`compress<class_GIProbe_property_compress>` | false |
|
|
+---------------------------------------+------------------------------------------------------------+-----------------------+
|
|
| :ref:`GIProbeData<class_GIProbeData>` | :ref:`data<class_GIProbe_property_data>` | |
|
|
+---------------------------------------+------------------------------------------------------------+-----------------------+
|
|
| :ref:`int<class_int>` | :ref:`dynamic_range<class_GIProbe_property_dynamic_range>` | 4 |
|
|
+---------------------------------------+------------------------------------------------------------+-----------------------+
|
|
| :ref:`float<class_float>` | :ref:`energy<class_GIProbe_property_energy>` | 1.0 |
|
|
+---------------------------------------+------------------------------------------------------------+-----------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`extents<class_GIProbe_property_extents>` | Vector3( 10, 10, 10 ) |
|
|
+---------------------------------------+------------------------------------------------------------+-----------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`interior<class_GIProbe_property_interior>` | false |
|
|
+---------------------------------------+------------------------------------------------------------+-----------------------+
|
|
| :ref:`float<class_float>` | :ref:`normal_bias<class_GIProbe_property_normal_bias>` | 0.0 |
|
|
+---------------------------------------+------------------------------------------------------------+-----------------------+
|
|
| :ref:`float<class_float>` | :ref:`propagation<class_GIProbe_property_propagation>` | 0.7 |
|
|
+---------------------------------------+------------------------------------------------------------+-----------------------+
|
|
| :ref:`Subdiv<enum_GIProbe_Subdiv>` | :ref:`subdiv<class_GIProbe_property_subdiv>` | 1 |
|
|
+---------------------------------------+------------------------------------------------------------+-----------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`bake<class_GIProbe_method_bake>` **(** :ref:`Node<class_Node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)** |
|
|
+------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`debug_bake<class_GIProbe_method_debug_bake>` **(** **)** |
|
|
+------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_GIProbe_Subdiv:
|
|
|
|
.. _class_GIProbe_constant_SUBDIV_64:
|
|
|
|
.. _class_GIProbe_constant_SUBDIV_128:
|
|
|
|
.. _class_GIProbe_constant_SUBDIV_256:
|
|
|
|
.. _class_GIProbe_constant_SUBDIV_512:
|
|
|
|
.. _class_GIProbe_constant_SUBDIV_MAX:
|
|
|
|
enum **Subdiv**:
|
|
|
|
- **SUBDIV_64** = **0**
|
|
|
|
- **SUBDIV_128** = **1**
|
|
|
|
- **SUBDIV_256** = **2**
|
|
|
|
- **SUBDIV_512** = **3**
|
|
|
|
- **SUBDIV_MAX** = **4** --- Represents the size of the :ref:`Subdiv<enum_GIProbe_Subdiv>` enum.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_GIProbe_property_bias:
|
|
|
|
- :ref:`float<class_float>` **bias**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | 1.5 |
|
|
+-----------+-----------------+
|
|
| *Setter* | set_bias(value) |
|
|
+-----------+-----------------+
|
|
| *Getter* | get_bias() |
|
|
+-----------+-----------------+
|
|
|
|
----
|
|
|
|
.. _class_GIProbe_property_compress:
|
|
|
|
- :ref:`bool<class_bool>` **compress**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | false |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_compress(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | is_compressed() |
|
|
+-----------+---------------------+
|
|
|
|
----
|
|
|
|
.. _class_GIProbe_property_data:
|
|
|
|
- :ref:`GIProbeData<class_GIProbeData>` **data**
|
|
|
|
+----------+-----------------------+
|
|
| *Setter* | set_probe_data(value) |
|
|
+----------+-----------------------+
|
|
| *Getter* | get_probe_data() |
|
|
+----------+-----------------------+
|
|
|
|
----
|
|
|
|
.. _class_GIProbe_property_dynamic_range:
|
|
|
|
- :ref:`int<class_int>` **dynamic_range**
|
|
|
|
+-----------+--------------------------+
|
|
| *Default* | 4 |
|
|
+-----------+--------------------------+
|
|
| *Setter* | set_dynamic_range(value) |
|
|
+-----------+--------------------------+
|
|
| *Getter* | get_dynamic_range() |
|
|
+-----------+--------------------------+
|
|
|
|
----
|
|
|
|
.. _class_GIProbe_property_energy:
|
|
|
|
- :ref:`float<class_float>` **energy**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | 1.0 |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_energy(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | get_energy() |
|
|
+-----------+-------------------+
|
|
|
|
----
|
|
|
|
.. _class_GIProbe_property_extents:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **extents**
|
|
|
|
+-----------+-----------------------+
|
|
| *Default* | Vector3( 10, 10, 10 ) |
|
|
+-----------+-----------------------+
|
|
| *Setter* | set_extents(value) |
|
|
+-----------+-----------------------+
|
|
| *Getter* | get_extents() |
|
|
+-----------+-----------------------+
|
|
|
|
----
|
|
|
|
.. _class_GIProbe_property_interior:
|
|
|
|
- :ref:`bool<class_bool>` **interior**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | false |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_interior(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | is_interior() |
|
|
+-----------+---------------------+
|
|
|
|
----
|
|
|
|
.. _class_GIProbe_property_normal_bias:
|
|
|
|
- :ref:`float<class_float>` **normal_bias**
|
|
|
|
+-----------+------------------------+
|
|
| *Default* | 0.0 |
|
|
+-----------+------------------------+
|
|
| *Setter* | set_normal_bias(value) |
|
|
+-----------+------------------------+
|
|
| *Getter* | get_normal_bias() |
|
|
+-----------+------------------------+
|
|
|
|
----
|
|
|
|
.. _class_GIProbe_property_propagation:
|
|
|
|
- :ref:`float<class_float>` **propagation**
|
|
|
|
+-----------+------------------------+
|
|
| *Default* | 0.7 |
|
|
+-----------+------------------------+
|
|
| *Setter* | set_propagation(value) |
|
|
+-----------+------------------------+
|
|
| *Getter* | get_propagation() |
|
|
+-----------+------------------------+
|
|
|
|
----
|
|
|
|
.. _class_GIProbe_property_subdiv:
|
|
|
|
- :ref:`Subdiv<enum_GIProbe_Subdiv>` **subdiv**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | 1 |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_subdiv(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | get_subdiv() |
|
|
+-----------+-------------------+
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_GIProbe_method_bake:
|
|
|
|
- void **bake** **(** :ref:`Node<class_Node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)**
|
|
|
|
----
|
|
|
|
.. _class_GIProbe_method_debug_bake:
|
|
|
|
- void **debug_bake** **(** **)**
|
|
|