godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (4c3dc26)

Browse Source
This commit is contained in:
Godot Organization
2023-09-28 11:42:41 +00:00
parent 5f8512fc20
commit ec62d34434
75 changed files with 2739 additions and 3244 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
classes/class_lightmapgi.rst
View File

@@ -53,6 +53,8 @@ Properties
+---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+
| :ref:`CameraAttributes<class_CameraAttributes>` | :ref:`camera_attributes<class_LightmapGI_property_camera_attributes>` | |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`denoiser_strength<class_LightmapGI_property_denoiser_strength>` | ``0.1`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+
| :ref:`bool<class_bool>` | :ref:`directional<class_LightmapGI_property_directional>` | ``false`` |
+---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+
| :ref:`Color<class_Color>` | :ref:`environment_custom_color<class_LightmapGI_property_environment_custom_color>` | |
@@ -367,6 +369,23 @@ The :ref:`CameraAttributes<class_CameraAttributes>` resource that specifies expo
----
.. _class_LightmapGI_property_denoiser_strength:
.. rst-class:: classref-property
:ref:`float<class_float>` **denoiser_strength** = ``0.1``
.. rst-class:: classref-property-setget
- void **set_denoiser_strength** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_denoiser_strength** **(** **)**
The strength of denoising step applied to the generated lightmaps. Only effective if :ref:`use_denoiser<class_LightmapGI_property_use_denoiser>` is ``true``.
.. rst-class:: classref-item-separator
----
.. _class_LightmapGI_property_directional:
.. rst-class:: classref-property
@@ -556,9 +575,7 @@ To further speed up bake times, decrease :ref:`bounces<class_LightmapGI_property
- void **set_use_denoiser** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_using_denoiser** **(** **)**
If ``true``, uses a CPU-based denoising algorithm on the generated lightmap. This eliminates most noise within the generated lightmap at the cost of longer bake times. File sizes are generally not impacted significantly by the use of a denoiser, although lossless compression may do a better job at compressing a denoised image.
\ **Note:** The built-in denoiser (OpenImageDenoise) may crash when denoising lightmaps in large scenes. If you encounter a crash at the end of lightmap baking, try disabling :ref:`use_denoiser<class_LightmapGI_property_use_denoiser>`.
If ``true``, uses a GPU-based denoising algorithm on the generated lightmap. This eliminates most noise within the generated lightmap at the cost of longer bake times. File sizes are generally not impacted significantly by the use of a denoiser, although lossless compression may do a better job at compressing a denoised image.
.. |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.)`