123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212 |
- .. 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>`
- **Category:** Core
- Brief Description
- -----------------
- Member Functions
- ----------------
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`bake<class_GIProbe_bake>` **(** :ref:`Node<class_node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)** |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`debug_bake<class_GIProbe_debug_bake>` **(** **)** |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_bias<class_GIProbe_get_bias>` **(** **)** const |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_dynamic_range<class_GIProbe_get_dynamic_range>` **(** **)** const |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_energy<class_GIProbe_get_energy>` **(** **)** const |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector3<class_vector3>` | :ref:`get_extents<class_GIProbe_get_extents>` **(** **)** const |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_normal_bias<class_GIProbe_get_normal_bias>` **(** **)** const |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`GIProbeData<class_giprobedata>` | :ref:`get_probe_data<class_GIProbe_get_probe_data>` **(** **)** const |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_propagation<class_GIProbe_get_propagation>` **(** **)** const |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_subdiv<class_GIProbe_get_subdiv>` **(** **)** const |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_compressed<class_GIProbe_is_compressed>` **(** **)** const |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_interior<class_GIProbe_is_interior>` **(** **)** const |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_bias<class_GIProbe_set_bias>` **(** :ref:`float<class_float>` max **)** |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_compress<class_GIProbe_set_compress>` **(** :ref:`bool<class_bool>` enable **)** |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_dynamic_range<class_GIProbe_set_dynamic_range>` **(** :ref:`int<class_int>` max **)** |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_energy<class_GIProbe_set_energy>` **(** :ref:`float<class_float>` max **)** |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_extents<class_GIProbe_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_interior<class_GIProbe_set_interior>` **(** :ref:`bool<class_bool>` enable **)** |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_normal_bias<class_GIProbe_set_normal_bias>` **(** :ref:`float<class_float>` max **)** |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_probe_data<class_GIProbe_set_probe_data>` **(** :ref:`GIProbeData<class_giprobedata>` data **)** |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_propagation<class_GIProbe_set_propagation>` **(** :ref:`float<class_float>` max **)** |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_subdiv<class_GIProbe_set_subdiv>` **(** :ref:`int<class_int>` subdiv **)** |
- +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- Member Variables
- ----------------
- .. _class_GIProbe_bias:
- - :ref:`float<class_float>` **bias**
- .. _class_GIProbe_compress:
- - :ref:`bool<class_bool>` **compress**
- .. _class_GIProbe_data:
- - :ref:`GIProbeData<class_giprobedata>` **data**
- .. _class_GIProbe_dynamic_range:
- - :ref:`int<class_int>` **dynamic_range**
- .. _class_GIProbe_energy:
- - :ref:`float<class_float>` **energy**
- .. _class_GIProbe_extents:
- - :ref:`Vector3<class_vector3>` **extents**
- .. _class_GIProbe_interior:
- - :ref:`bool<class_bool>` **interior**
- .. _class_GIProbe_normal_bias:
- - :ref:`float<class_float>` **normal_bias**
- .. _class_GIProbe_propagation:
- - :ref:`float<class_float>` **propagation**
- .. _class_GIProbe_subdiv:
- - :ref:`int<class_int>` **subdiv**
- Numeric Constants
- -----------------
- - **SUBDIV_64** = **0**
- - **SUBDIV_128** = **1**
- - **SUBDIV_256** = **2**
- - **SUBDIV_512** = **3**
- - **SUBDIV_MAX** = **4**
- Member Function Description
- ---------------------------
- .. _class_GIProbe_bake:
- - void **bake** **(** :ref:`Node<class_node>` from_node=null, :ref:`bool<class_bool>` create_visual_debug=false **)**
- .. _class_GIProbe_debug_bake:
- - void **debug_bake** **(** **)**
- .. _class_GIProbe_get_bias:
- - :ref:`float<class_float>` **get_bias** **(** **)** const
- .. _class_GIProbe_get_dynamic_range:
- - :ref:`int<class_int>` **get_dynamic_range** **(** **)** const
- .. _class_GIProbe_get_energy:
- - :ref:`float<class_float>` **get_energy** **(** **)** const
- .. _class_GIProbe_get_extents:
- - :ref:`Vector3<class_vector3>` **get_extents** **(** **)** const
- .. _class_GIProbe_get_normal_bias:
- - :ref:`float<class_float>` **get_normal_bias** **(** **)** const
- .. _class_GIProbe_get_probe_data:
- - :ref:`GIProbeData<class_giprobedata>` **get_probe_data** **(** **)** const
- .. _class_GIProbe_get_propagation:
- - :ref:`float<class_float>` **get_propagation** **(** **)** const
- .. _class_GIProbe_get_subdiv:
- - :ref:`int<class_int>` **get_subdiv** **(** **)** const
- .. _class_GIProbe_is_compressed:
- - :ref:`bool<class_bool>` **is_compressed** **(** **)** const
- .. _class_GIProbe_is_interior:
- - :ref:`bool<class_bool>` **is_interior** **(** **)** const
- .. _class_GIProbe_set_bias:
- - void **set_bias** **(** :ref:`float<class_float>` max **)**
- .. _class_GIProbe_set_compress:
- - void **set_compress** **(** :ref:`bool<class_bool>` enable **)**
- .. _class_GIProbe_set_dynamic_range:
- - void **set_dynamic_range** **(** :ref:`int<class_int>` max **)**
- .. _class_GIProbe_set_energy:
- - void **set_energy** **(** :ref:`float<class_float>` max **)**
- .. _class_GIProbe_set_extents:
- - void **set_extents** **(** :ref:`Vector3<class_vector3>` extents **)**
- .. _class_GIProbe_set_interior:
- - void **set_interior** **(** :ref:`bool<class_bool>` enable **)**
- .. _class_GIProbe_set_normal_bias:
- - void **set_normal_bias** **(** :ref:`float<class_float>` max **)**
- .. _class_GIProbe_set_probe_data:
- - void **set_probe_data** **(** :ref:`GIProbeData<class_giprobedata>` data **)**
- .. _class_GIProbe_set_propagation:
- - void **set_propagation** **(** :ref:`float<class_float>` max **)**
- .. _class_GIProbe_set_subdiv:
- - void **set_subdiv** **(** :ref:`int<class_int>` subdiv **)**
|