godot-docs/classes/class_giprobedata.rst

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

.. _class_GIProbeData:

GIProbeData
===========

**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`

**Category:** Core

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



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

+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                | :ref:`get_bias<class_GIProbeData_get_bias>`  **(** **)** const                                                                 |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect3<class_rect3>`                | :ref:`get_bounds<class_GIProbeData_get_bounds>`  **(** **)** const                                                             |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                | :ref:`get_cell_size<class_GIProbeData_get_cell_size>`  **(** **)** const                                                       |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>`  | :ref:`get_dynamic_data<class_GIProbeData_get_dynamic_data>`  **(** **)** const                                                 |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                    | :ref:`get_dynamic_range<class_GIProbeData_get_dynamic_range>`  **(** **)** const                                               |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                | :ref:`get_energy<class_GIProbeData_get_energy>`  **(** **)** const                                                             |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                | :ref:`get_normal_bias<class_GIProbeData_get_normal_bias>`  **(** **)** const                                                   |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                | :ref:`get_propagation<class_GIProbeData_get_propagation>`  **(** **)** const                                                   |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>`        | :ref:`get_to_cell_xform<class_GIProbeData_get_to_cell_xform>`  **(** **)** const                                               |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                  | :ref:`is_compressed<class_GIProbeData_is_compressed>`  **(** **)** const                                                       |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                  | :ref:`is_interior<class_GIProbeData_is_interior>`  **(** **)** const                                                           |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_bias<class_GIProbeData_set_bias>`  **(** :ref:`float<class_float>` bias  **)**                                       |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_bounds<class_GIProbeData_set_bounds>`  **(** :ref:`Rect3<class_rect3>` bounds  **)**                                 |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_cell_size<class_GIProbeData_set_cell_size>`  **(** :ref:`float<class_float>` cell_size  **)**                        |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_compress<class_GIProbeData_set_compress>`  **(** :ref:`bool<class_bool>` compress  **)**                             |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_dynamic_data<class_GIProbeData_set_dynamic_data>`  **(** :ref:`PoolIntArray<class_poolintarray>` dynamic_data  **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_dynamic_range<class_GIProbeData_set_dynamic_range>`  **(** :ref:`int<class_int>` dynamic_range  **)**                |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_energy<class_GIProbeData_set_energy>`  **(** :ref:`float<class_float>` energy  **)**                                 |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_interior<class_GIProbeData_set_interior>`  **(** :ref:`bool<class_bool>` interior  **)**                             |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_normal_bias<class_GIProbeData_set_normal_bias>`  **(** :ref:`float<class_float>` bias  **)**                         |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_propagation<class_GIProbeData_set_propagation>`  **(** :ref:`float<class_float>` propagation  **)**                  |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void                                     | :ref:`set_to_cell_xform<class_GIProbeData_set_to_cell_xform>`  **(** :ref:`Transform<class_transform>` to_cell_xform  **)**    |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+

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

- :ref:`float<class_float>` **bias**
- :ref:`Rect3<class_rect3>` **bounds**
- :ref:`float<class_float>` **cell_size**
- :ref:`bool<class_bool>` **compress**
- :ref:`PoolIntArray<class_poolintarray>` **dynamic_data**
- :ref:`int<class_int>` **dynamic_range**
- :ref:`float<class_float>` **energy**
- :ref:`bool<class_bool>` **interior**
- :ref:`float<class_float>` **normal_bias**
- :ref:`float<class_float>` **propagation**
- :ref:`Transform<class_transform>` **to_cell_xform**

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

.. _class_GIProbeData_get_bias:

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

.. _class_GIProbeData_get_bounds:

- :ref:`Rect3<class_rect3>`  **get_bounds**  **(** **)** const

.. _class_GIProbeData_get_cell_size:

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

.. _class_GIProbeData_get_dynamic_data:

- :ref:`PoolIntArray<class_poolintarray>`  **get_dynamic_data**  **(** **)** const

.. _class_GIProbeData_get_dynamic_range:

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

.. _class_GIProbeData_get_energy:

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

.. _class_GIProbeData_get_normal_bias:

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

.. _class_GIProbeData_get_propagation:

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

.. _class_GIProbeData_get_to_cell_xform:

- :ref:`Transform<class_transform>`  **get_to_cell_xform**  **(** **)** const

.. _class_GIProbeData_is_compressed:

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

.. _class_GIProbeData_is_interior:

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

.. _class_GIProbeData_set_bias:

- void  **set_bias**  **(** :ref:`float<class_float>` bias  **)**

.. _class_GIProbeData_set_bounds:

- void  **set_bounds**  **(** :ref:`Rect3<class_rect3>` bounds  **)**

.. _class_GIProbeData_set_cell_size:

- void  **set_cell_size**  **(** :ref:`float<class_float>` cell_size  **)**

.. _class_GIProbeData_set_compress:

- void  **set_compress**  **(** :ref:`bool<class_bool>` compress  **)**

.. _class_GIProbeData_set_dynamic_data:

- void  **set_dynamic_data**  **(** :ref:`PoolIntArray<class_poolintarray>` dynamic_data  **)**

.. _class_GIProbeData_set_dynamic_range:

- void  **set_dynamic_range**  **(** :ref:`int<class_int>` dynamic_range  **)**

.. _class_GIProbeData_set_energy:

- void  **set_energy**  **(** :ref:`float<class_float>` energy  **)**

.. _class_GIProbeData_set_interior:

- void  **set_interior**  **(** :ref:`bool<class_bool>` interior  **)**

.. _class_GIProbeData_set_normal_bias:

- void  **set_normal_bias**  **(** :ref:`float<class_float>` bias  **)**

.. _class_GIProbeData_set_propagation:

- void  **set_propagation**  **(** :ref:`float<class_float>` propagation  **)**

.. _class_GIProbeData_set_to_cell_xform:

- void  **set_to_cell_xform**  **(** :ref:`Transform<class_transform>` to_cell_xform  **)**