| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the BakedLightmapData.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_BakedLightmapData:
- BakedLightmapData
- =================
- **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- Properties
- ----------
- +-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`AABB<class_AABB>` | :ref:`bounds<class_BakedLightmapData_property_bounds>` | ``AABB( 0, 0, 0, 0, 0, 0 )`` |
- +-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`Transform<class_Transform>` | :ref:`cell_space_transform<class_BakedLightmapData_property_cell_space_transform>` | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
- +-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`cell_subdiv<class_BakedLightmapData_property_cell_subdiv>` | ``1`` |
- +-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`energy<class_BakedLightmapData_property_energy>` | ``1.0`` |
- +-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`interior<class_BakedLightmapData_property_interior>` | ``false`` |
- +-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`octree<class_BakedLightmapData_property_octree>` | ``PoolByteArray( )`` |
- +-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
- Methods
- -------
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_user<class_BakedLightmapData_method_add_user>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`Resource<class_Resource>` lightmap, :ref:`int<class_int>` lightmap_slice, :ref:`Rect2<class_Rect2>` lightmap_uv_rect, :ref:`int<class_int>` instance **)** |
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`clear_data<class_BakedLightmapData_method_clear_data>` **(** **)** |
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`clear_users<class_BakedLightmapData_method_clear_users>` **(** **)** |
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_user_count<class_BakedLightmapData_method_get_user_count>` **(** **)** |const| |
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Resource<class_Resource>` | :ref:`get_user_lightmap<class_BakedLightmapData_method_get_user_lightmap>` **(** :ref:`int<class_int>` user_idx **)** |const| |
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`NodePath<class_NodePath>` | :ref:`get_user_path<class_BakedLightmapData_method_get_user_path>` **(** :ref:`int<class_int>` user_idx **)** |const| |
- +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_BakedLightmapData_property_bounds:
- - :ref:`AABB<class_AABB>` **bounds**
- +-----------+------------------------------+
- | *Default* | ``AABB( 0, 0, 0, 0, 0, 0 )`` |
- +-----------+------------------------------+
- | *Setter* | set_bounds(value) |
- +-----------+------------------------------+
- | *Getter* | get_bounds() |
- +-----------+------------------------------+
- ----
- .. _class_BakedLightmapData_property_cell_space_transform:
- - :ref:`Transform<class_Transform>` **cell_space_transform**
- +-----------+-----------------------------------------------------+
- | *Default* | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
- +-----------+-----------------------------------------------------+
- | *Setter* | set_cell_space_transform(value) |
- +-----------+-----------------------------------------------------+
- | *Getter* | get_cell_space_transform() |
- +-----------+-----------------------------------------------------+
- ----
- .. _class_BakedLightmapData_property_cell_subdiv:
- - :ref:`int<class_int>` **cell_subdiv**
- +-----------+------------------------+
- | *Default* | ``1`` |
- +-----------+------------------------+
- | *Setter* | set_cell_subdiv(value) |
- +-----------+------------------------+
- | *Getter* | get_cell_subdiv() |
- +-----------+------------------------+
- ----
- .. _class_BakedLightmapData_property_energy:
- - :ref:`float<class_float>` **energy**
- +-----------+-------------------+
- | *Default* | ``1.0`` |
- +-----------+-------------------+
- | *Setter* | set_energy(value) |
- +-----------+-------------------+
- | *Getter* | get_energy() |
- +-----------+-------------------+
- Global energy multiplier for baked and dynamic capture objects. This can be changed at run-time without having to bake lightmaps again.
- To adjust only the energy of indirect lighting (without affecting direct lighting or emissive materials), adjust :ref:`BakedLightmap.bounce_indirect_energy<class_BakedLightmap_property_bounce_indirect_energy>` and bake lightmaps again.
- ----
- .. _class_BakedLightmapData_property_interior:
- - :ref:`bool<class_bool>` **interior**
- +-----------+---------------------+
- | *Default* | ``false`` |
- +-----------+---------------------+
- | *Setter* | set_interior(value) |
- +-----------+---------------------+
- | *Getter* | is_interior() |
- +-----------+---------------------+
- Controls whether dynamic capture objects receive environment lighting or not.
- ----
- .. _class_BakedLightmapData_property_octree:
- - :ref:`PoolByteArray<class_PoolByteArray>` **octree**
- +-----------+-----------------------+
- | *Default* | ``PoolByteArray( )`` |
- +-----------+-----------------------+
- | *Setter* | set_octree(value) |
- +-----------+-----------------------+
- | *Getter* | get_octree() |
- +-----------+-----------------------+
- Method Descriptions
- -------------------
- .. _class_BakedLightmapData_method_add_user:
- - void **add_user** **(** :ref:`NodePath<class_NodePath>` path, :ref:`Resource<class_Resource>` lightmap, :ref:`int<class_int>` lightmap_slice, :ref:`Rect2<class_Rect2>` lightmap_uv_rect, :ref:`int<class_int>` instance **)**
- ----
- .. _class_BakedLightmapData_method_clear_data:
- - void **clear_data** **(** **)**
- ----
- .. _class_BakedLightmapData_method_clear_users:
- - void **clear_users** **(** **)**
- ----
- .. _class_BakedLightmapData_method_get_user_count:
- - :ref:`int<class_int>` **get_user_count** **(** **)** |const|
- ----
- .. _class_BakedLightmapData_method_get_user_lightmap:
- - :ref:`Resource<class_Resource>` **get_user_lightmap** **(** :ref:`int<class_int>` user_idx **)** |const|
- ----
- .. _class_BakedLightmapData_method_get_user_path:
- - :ref:`NodePath<class_NodePath>` **get_user_path** **(** :ref:`int<class_int>` user_idx **)** |const|
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
