godot-docs/classes/class_giprobedata.rst

:github_url: hide

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



Properties
----------

+---------------------------+----------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`anisotropy_strength<class_GIProbeData_property_anisotropy_strength>` | ``0.5``   |
+---------------------------+----------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`ao<class_GIProbeData_property_ao>`                                   | ``0.0``   |
+---------------------------+----------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`ao_size<class_GIProbeData_property_ao_size>`                         | ``0.5``   |
+---------------------------+----------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`bias<class_GIProbeData_property_bias>`                               | ``1.5``   |
+---------------------------+----------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`dynamic_range<class_GIProbeData_property_dynamic_range>`             | ``4.0``   |
+---------------------------+----------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`energy<class_GIProbeData_property_energy>`                           | ``1.0``   |
+---------------------------+----------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`   | :ref:`interior<class_GIProbeData_property_interior>`                       | ``false`` |
+---------------------------+----------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`normal_bias<class_GIProbeData_property_normal_bias>`                 | ``0.0``   |
+---------------------------+----------------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`propagation<class_GIProbeData_property_propagation>`                 | ``0.7``   |
+---------------------------+----------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`   | :ref:`use_two_bounces<class_GIProbeData_property_use_two_bounces>`         | ``false`` |
+---------------------------+----------------------------------------------------------------------------+-----------+

Methods
-------

+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`allocate<class_GIProbeData_method_allocate>` **(** :ref:`Transform<class_Transform>` to_cell_xform, :ref:`AABB<class_AABB>` aabb, :ref:`Vector3<class_Vector3>` octree_size, :ref:`PackedByteArray<class_PackedByteArray>` octree_cells, :ref:`PackedByteArray<class_PackedByteArray>` data_cells, :ref:`PackedByteArray<class_PackedByteArray>` distance_field, :ref:`PackedInt32Array<class_PackedInt32Array>` level_counts **)** |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_AABB>`                         | :ref:`get_bounds<class_GIProbeData_method_get_bounds>` **(** **)** const                                                                                                                                                                                                                                                                                                                                                                  |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedByteArray<class_PackedByteArray>`   | :ref:`get_data_cells<class_GIProbeData_method_get_data_cells>` **(** **)** const                                                                                                                                                                                                                                                                                                                                                          |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_level_counts<class_GIProbeData_method_get_level_counts>` **(** **)** const                                                                                                                                                                                                                                                                                                                                                      |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedByteArray<class_PackedByteArray>`   | :ref:`get_octree_cells<class_GIProbeData_method_get_octree_cells>` **(** **)** const                                                                                                                                                                                                                                                                                                                                                      |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>`                   | :ref:`get_octree_size<class_GIProbeData_method_get_octree_size>` **(** **)** const                                                                                                                                                                                                                                                                                                                                                        |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_Transform>`               | :ref:`get_to_cell_xform<class_GIProbeData_method_get_to_cell_xform>` **(** **)** const                                                                                                                                                                                                                                                                                                                                                    |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

.. _class_GIProbeData_property_anisotropy_strength:

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

+-----------+--------------------------------+
| *Default* | ``0.5``                        |
+-----------+--------------------------------+
| *Setter*  | set_anisotropy_strength(value) |
+-----------+--------------------------------+
| *Getter*  | get_anisotropy_strength()      |
+-----------+--------------------------------+

----

.. _class_GIProbeData_property_ao:

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

+-----------+---------------+
| *Default* | ``0.0``       |
+-----------+---------------+
| *Setter*  | set_ao(value) |
+-----------+---------------+
| *Getter*  | get_ao()      |
+-----------+---------------+

----

.. _class_GIProbeData_property_ao_size:

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

+-----------+--------------------+
| *Default* | ``0.5``            |
+-----------+--------------------+
| *Setter*  | set_ao_size(value) |
+-----------+--------------------+
| *Getter*  | get_ao_size()      |
+-----------+--------------------+

----

.. _class_GIProbeData_property_bias:

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

+-----------+-----------------+
| *Default* | ``1.5``         |
+-----------+-----------------+
| *Setter*  | set_bias(value) |
+-----------+-----------------+
| *Getter*  | get_bias()      |
+-----------+-----------------+

----

.. _class_GIProbeData_property_dynamic_range:

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

+-----------+--------------------------+
| *Default* | ``4.0``                  |
+-----------+--------------------------+
| *Setter*  | set_dynamic_range(value) |
+-----------+--------------------------+
| *Getter*  | get_dynamic_range()      |
+-----------+--------------------------+

----

.. _class_GIProbeData_property_energy:

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

+-----------+-------------------+
| *Default* | ``1.0``           |
+-----------+-------------------+
| *Setter*  | set_energy(value) |
+-----------+-------------------+
| *Getter*  | get_energy()      |
+-----------+-------------------+

----

.. _class_GIProbeData_property_interior:

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

+-----------+---------------------+
| *Default* | ``false``           |
+-----------+---------------------+
| *Setter*  | set_interior(value) |
+-----------+---------------------+
| *Getter*  | is_interior()       |
+-----------+---------------------+

----

.. _class_GIProbeData_property_normal_bias:

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

+-----------+------------------------+
| *Default* | ``0.0``                |
+-----------+------------------------+
| *Setter*  | set_normal_bias(value) |
+-----------+------------------------+
| *Getter*  | get_normal_bias()      |
+-----------+------------------------+

----

.. _class_GIProbeData_property_propagation:

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

+-----------+------------------------+
| *Default* | ``0.7``                |
+-----------+------------------------+
| *Setter*  | set_propagation(value) |
+-----------+------------------------+
| *Getter*  | get_propagation()      |
+-----------+------------------------+

----

.. _class_GIProbeData_property_use_two_bounces:

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

+-----------+----------------------------+
| *Default* | ``false``                  |
+-----------+----------------------------+
| *Setter*  | set_use_two_bounces(value) |
+-----------+----------------------------+
| *Getter*  | is_using_two_bounces()     |
+-----------+----------------------------+

Method Descriptions
-------------------

.. _class_GIProbeData_method_allocate:

- void **allocate** **(** :ref:`Transform<class_Transform>` to_cell_xform, :ref:`AABB<class_AABB>` aabb, :ref:`Vector3<class_Vector3>` octree_size, :ref:`PackedByteArray<class_PackedByteArray>` octree_cells, :ref:`PackedByteArray<class_PackedByteArray>` data_cells, :ref:`PackedByteArray<class_PackedByteArray>` distance_field, :ref:`PackedInt32Array<class_PackedInt32Array>` level_counts **)**

----

.. _class_GIProbeData_method_get_bounds:

- :ref:`AABB<class_AABB>` **get_bounds** **(** **)** const

----

.. _class_GIProbeData_method_get_data_cells:

- :ref:`PackedByteArray<class_PackedByteArray>` **get_data_cells** **(** **)** const

----

.. _class_GIProbeData_method_get_level_counts:

- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_level_counts** **(** **)** const

----

.. _class_GIProbeData_method_get_octree_cells:

- :ref:`PackedByteArray<class_PackedByteArray>` **get_octree_cells** **(** **)** const

----

.. _class_GIProbeData_method_get_octree_size:

- :ref:`Vector3<class_Vector3>` **get_octree_size** **(** **)** const

----

.. _class_GIProbeData_method_get_to_cell_xform:

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