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

**Category:** Core

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



Properties
----------

+-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+
| :ref:`float<class_float>`               | :ref:`bias<class_GIProbeData_property_bias>`                   | 0.4                                             |
+-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+
| :ref:`AABB<class_AABB>`                 | :ref:`bounds<class_GIProbeData_property_bounds>`               | AABB( 0, 0, 0, 1, 1, 1 )                        |
+-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+
| :ref:`float<class_float>`               | :ref:`cell_size<class_GIProbeData_property_cell_size>`         | 1.0                                             |
+-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+
| :ref:`bool<class_bool>`                 | :ref:`compress<class_GIProbeData_property_compress>`           | false                                           |
+-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`dynamic_data<class_GIProbeData_property_dynamic_data>`   | PoolIntArray(  )                                |
+-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+
| :ref:`int<class_int>`                   | :ref:`dynamic_range<class_GIProbeData_property_dynamic_range>` | 1                                               |
+-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+
| :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.4                                             |
+-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+
| :ref:`float<class_float>`               | :ref:`propagation<class_GIProbeData_property_propagation>`     | 1.0                                             |
+-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+
| :ref:`Transform<class_Transform>`       | :ref:`to_cell_xform<class_GIProbeData_property_to_cell_xform>` | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) |
+-----------------------------------------+----------------------------------------------------------------+-------------------------------------------------+

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

.. _class_GIProbeData_property_bias:

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

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

.. _class_GIProbeData_property_bounds:

- :ref:`AABB<class_AABB>` **bounds**

+-----------+--------------------------+
| *Default* | AABB( 0, 0, 0, 1, 1, 1 ) |
+-----------+--------------------------+
| *Setter*  | set_bounds(value)        |
+-----------+--------------------------+
| *Getter*  | get_bounds()             |
+-----------+--------------------------+

.. _class_GIProbeData_property_cell_size:

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

+-----------+----------------------+
| *Default* | 1.0                  |
+-----------+----------------------+
| *Setter*  | set_cell_size(value) |
+-----------+----------------------+
| *Getter*  | get_cell_size()      |
+-----------+----------------------+

.. _class_GIProbeData_property_compress:

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

+-----------+---------------------+
| *Default* | false               |
+-----------+---------------------+
| *Setter*  | set_compress(value) |
+-----------+---------------------+
| *Getter*  | is_compressed()     |
+-----------+---------------------+

.. _class_GIProbeData_property_dynamic_data:

- :ref:`PoolIntArray<class_PoolIntArray>` **dynamic_data**

+-----------+-------------------------+
| *Default* | PoolIntArray(  )        |
+-----------+-------------------------+
| *Setter*  | set_dynamic_data(value) |
+-----------+-------------------------+
| *Getter*  | get_dynamic_data()      |
+-----------+-------------------------+

.. _class_GIProbeData_property_dynamic_range:

- :ref:`int<class_int>` **dynamic_range**

+-----------+--------------------------+
| *Default* | 1                        |
+-----------+--------------------------+
| *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.4                    |
+-----------+------------------------+
| *Setter*  | set_normal_bias(value) |
+-----------+------------------------+
| *Getter*  | get_normal_bias()      |
+-----------+------------------------+

.. _class_GIProbeData_property_propagation:

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

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

.. _class_GIProbeData_property_to_cell_xform:

- :ref:`Transform<class_Transform>` **to_cell_xform**

+-----------+-------------------------------------------------+
| *Default* | Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 ) |
+-----------+-------------------------------------------------+
| *Setter*  | set_to_cell_xform(value)                        |
+-----------+-------------------------------------------------+
| *Getter*  | get_to_cell_xform()                             |
+-----------+-------------------------------------------------+