.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/LightmapGI.xml. .. _class_LightmapGI: LightmapGI ========== **Inherits:** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`float` | :ref:`bias` | ``0.0005`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`float` | :ref:`bounce_indirect_energy` | ``1.0`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`int` | :ref:`bounces` | ``3`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`CameraAttributes` | :ref:`camera_attributes` | | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`int` | :ref:`denoiser_range` | ``10`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`float` | :ref:`denoiser_strength` | ``0.1`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`bool` | :ref:`directional` | ``false`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`Color` | :ref:`environment_custom_color` | | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`float` | :ref:`environment_custom_energy` | | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`Sky` | :ref:`environment_custom_sky` | | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`EnvironmentMode` | :ref:`environment_mode` | ``1`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`GenerateProbes` | :ref:`generate_probes_subdiv` | ``2`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`bool` | :ref:`interior` | ``false`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`LightmapGIData` | :ref:`light_data` | | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`int` | :ref:`max_texture_size` | ``16384`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`BakeQuality` | :ref:`quality` | ``1`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`float` | :ref:`texel_scale` | ``1.0`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`bool` | :ref:`use_denoiser` | ``true`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`bool` | :ref:`use_texture_for_bounces` | ``true`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_LightmapGI_BakeQuality: .. rst-class:: classref-enumeration enum **BakeQuality**: .. _class_LightmapGI_constant_BAKE_QUALITY_LOW: .. rst-class:: classref-enumeration-constant :ref:`BakeQuality` **BAKE_QUALITY_LOW** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_QUALITY_MEDIUM: .. rst-class:: classref-enumeration-constant :ref:`BakeQuality` **BAKE_QUALITY_MEDIUM** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_QUALITY_HIGH: .. rst-class:: classref-enumeration-constant :ref:`BakeQuality` **BAKE_QUALITY_HIGH** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_QUALITY_ULTRA: .. rst-class:: classref-enumeration-constant :ref:`BakeQuality` **BAKE_QUALITY_ULTRA** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_LightmapGI_GenerateProbes: .. rst-class:: classref-enumeration enum **GenerateProbes**: .. _class_LightmapGI_constant_GENERATE_PROBES_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`GenerateProbes` **GENERATE_PROBES_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_GENERATE_PROBES_SUBDIV_4: .. rst-class:: classref-enumeration-constant :ref:`GenerateProbes` **GENERATE_PROBES_SUBDIV_4** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_GENERATE_PROBES_SUBDIV_8: .. rst-class:: classref-enumeration-constant :ref:`GenerateProbes` **GENERATE_PROBES_SUBDIV_8** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_GENERATE_PROBES_SUBDIV_16: .. rst-class:: classref-enumeration-constant :ref:`GenerateProbes` **GENERATE_PROBES_SUBDIV_16** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_GENERATE_PROBES_SUBDIV_32: .. rst-class:: classref-enumeration-constant :ref:`GenerateProbes` **GENERATE_PROBES_SUBDIV_32** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_LightmapGI_BakeError: .. rst-class:: classref-enumeration enum **BakeError**: .. _class_LightmapGI_constant_BAKE_ERROR_OK: .. rst-class:: classref-enumeration-constant :ref:`BakeError` **BAKE_ERROR_OK** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_ERROR_NO_SCENE_ROOT: .. rst-class:: classref-enumeration-constant :ref:`BakeError` **BAKE_ERROR_NO_SCENE_ROOT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_ERROR_FOREIGN_DATA: .. rst-class:: classref-enumeration-constant :ref:`BakeError` **BAKE_ERROR_FOREIGN_DATA** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_ERROR_NO_LIGHTMAPPER: .. rst-class:: classref-enumeration-constant :ref:`BakeError` **BAKE_ERROR_NO_LIGHTMAPPER** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_ERROR_NO_SAVE_PATH: .. rst-class:: classref-enumeration-constant :ref:`BakeError` **BAKE_ERROR_NO_SAVE_PATH** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_ERROR_NO_MESHES: .. rst-class:: classref-enumeration-constant :ref:`BakeError` **BAKE_ERROR_NO_MESHES** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_ERROR_MESHES_INVALID: .. rst-class:: classref-enumeration-constant :ref:`BakeError` **BAKE_ERROR_MESHES_INVALID** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_ERROR_CANT_CREATE_IMAGE: .. rst-class:: classref-enumeration-constant :ref:`BakeError` **BAKE_ERROR_CANT_CREATE_IMAGE** = ``7`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_ERROR_USER_ABORTED: .. rst-class:: classref-enumeration-constant :ref:`BakeError` **BAKE_ERROR_USER_ABORTED** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_ERROR_TEXTURE_SIZE_TOO_SMALL: .. rst-class:: classref-enumeration-constant :ref:`BakeError` **BAKE_ERROR_TEXTURE_SIZE_TOO_SMALL** = ``9`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_ERROR_LIGHTMAP_TOO_SMALL: .. rst-class:: classref-enumeration-constant :ref:`BakeError` **BAKE_ERROR_LIGHTMAP_TOO_SMALL** = ``10`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_BAKE_ERROR_ATLAS_TOO_SMALL: .. rst-class:: classref-enumeration-constant :ref:`BakeError` **BAKE_ERROR_ATLAS_TOO_SMALL** = ``11`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_LightmapGI_EnvironmentMode: .. rst-class:: classref-enumeration enum **EnvironmentMode**: .. _class_LightmapGI_constant_ENVIRONMENT_MODE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentMode` **ENVIRONMENT_MODE_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_ENVIRONMENT_MODE_SCENE: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentMode` **ENVIRONMENT_MODE_SCENE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_ENVIRONMENT_MODE_CUSTOM_SKY: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentMode` **ENVIRONMENT_MODE_CUSTOM_SKY** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_LightmapGI_constant_ENVIRONMENT_MODE_CUSTOM_COLOR: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentMode` **ENVIRONMENT_MODE_CUSTOM_COLOR** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_LightmapGI_property_bias: .. rst-class:: classref-property :ref:`float` **bias** = ``0.0005`` .. rst-class:: classref-property-setget - void **set_bias** **(** :ref:`float` value **)** - :ref:`float` **get_bias** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_bounce_indirect_energy: .. rst-class:: classref-property :ref:`float` **bounce_indirect_energy** = ``1.0`` .. rst-class:: classref-property-setget - void **set_bounce_indirect_energy** **(** :ref:`float` value **)** - :ref:`float` **get_bounce_indirect_energy** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_bounces: .. rst-class:: classref-property :ref:`int` **bounces** = ``3`` .. rst-class:: classref-property-setget - void **set_bounces** **(** :ref:`int` value **)** - :ref:`int` **get_bounces** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_camera_attributes: .. rst-class:: classref-property :ref:`CameraAttributes` **camera_attributes** .. rst-class:: classref-property-setget - void **set_camera_attributes** **(** :ref:`CameraAttributes` value **)** - :ref:`CameraAttributes` **get_camera_attributes** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_denoiser_range: .. rst-class:: classref-property :ref:`int` **denoiser_range** = ``10`` .. rst-class:: classref-property-setget - void **set_denoiser_range** **(** :ref:`int` value **)** - :ref:`int` **get_denoiser_range** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_denoiser_strength: .. rst-class:: classref-property :ref:`float` **denoiser_strength** = ``0.1`` .. rst-class:: classref-property-setget - void **set_denoiser_strength** **(** :ref:`float` value **)** - :ref:`float` **get_denoiser_strength** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_directional: .. rst-class:: classref-property :ref:`bool` **directional** = ``false`` .. rst-class:: classref-property-setget - void **set_directional** **(** :ref:`bool` value **)** - :ref:`bool` **is_directional** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_environment_custom_color: .. rst-class:: classref-property :ref:`Color` **environment_custom_color** .. rst-class:: classref-property-setget - void **set_environment_custom_color** **(** :ref:`Color` value **)** - :ref:`Color` **get_environment_custom_color** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_environment_custom_energy: .. rst-class:: classref-property :ref:`float` **environment_custom_energy** .. rst-class:: classref-property-setget - void **set_environment_custom_energy** **(** :ref:`float` value **)** - :ref:`float` **get_environment_custom_energy** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_environment_custom_sky: .. rst-class:: classref-property :ref:`Sky` **environment_custom_sky** .. rst-class:: classref-property-setget - void **set_environment_custom_sky** **(** :ref:`Sky` value **)** - :ref:`Sky` **get_environment_custom_sky** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_environment_mode: .. rst-class:: classref-property :ref:`EnvironmentMode` **environment_mode** = ``1`` .. rst-class:: classref-property-setget - void **set_environment_mode** **(** :ref:`EnvironmentMode` value **)** - :ref:`EnvironmentMode` **get_environment_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_generate_probes_subdiv: .. rst-class:: classref-property :ref:`GenerateProbes` **generate_probes_subdiv** = ``2`` .. rst-class:: classref-property-setget - void **set_generate_probes** **(** :ref:`GenerateProbes` value **)** - :ref:`GenerateProbes` **get_generate_probes** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_interior: .. rst-class:: classref-property :ref:`bool` **interior** = ``false`` .. rst-class:: classref-property-setget - void **set_interior** **(** :ref:`bool` value **)** - :ref:`bool` **is_interior** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_light_data: .. rst-class:: classref-property :ref:`LightmapGIData` **light_data** .. rst-class:: classref-property-setget - void **set_light_data** **(** :ref:`LightmapGIData` value **)** - :ref:`LightmapGIData` **get_light_data** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_max_texture_size: .. rst-class:: classref-property :ref:`int` **max_texture_size** = ``16384`` .. rst-class:: classref-property-setget - void **set_max_texture_size** **(** :ref:`int` value **)** - :ref:`int` **get_max_texture_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_quality: .. rst-class:: classref-property :ref:`BakeQuality` **quality** = ``1`` .. rst-class:: classref-property-setget - void **set_bake_quality** **(** :ref:`BakeQuality` value **)** - :ref:`BakeQuality` **get_bake_quality** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_texel_scale: .. rst-class:: classref-property :ref:`float` **texel_scale** = ``1.0`` .. rst-class:: classref-property-setget - void **set_texel_scale** **(** :ref:`float` value **)** - :ref:`float` **get_texel_scale** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_use_denoiser: .. rst-class:: classref-property :ref:`bool` **use_denoiser** = ``true`` .. rst-class:: classref-property-setget - void **set_use_denoiser** **(** :ref:`bool` value **)** - :ref:`bool` **is_using_denoiser** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_LightmapGI_property_use_texture_for_bounces: .. rst-class:: classref-property :ref:`bool` **use_texture_for_bounces** = ``true`` .. rst-class:: classref-property-setget - void **set_use_texture_for_bounces** **(** :ref:`bool` value **)** - :ref:`bool` **is_using_texture_for_bounces** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`