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 latest 4.0-alpha

Browse Source
This commit is contained in:
Rémi Verschelde
2022-02-01 16:35:13 +01:00
parent dd764520c6
commit 551ab512ca
419 changed files with 12867 additions and 9872 deletions
Download Patch File Download Diff File Expand all files Collapse all files

160
classes/class_environment.rst
View File

@@ -125,6 +125,10 @@ Properties
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`float<class_float>` | :ref:`glow_levels/7<class_Environment_property_glow_levels/7>` | ``0.0`` |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`Texture<class_Texture>` | :ref:`glow_map<class_Environment_property_glow_map>` | |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`float<class_float>` | :ref:`glow_map_strength<class_Environment_property_glow_map_strength>` | ``0.8`` |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`float<class_float>` | :ref:`glow_mix<class_Environment_property_glow_mix>` | ``0.05`` |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`bool<class_bool>` | :ref:`glow_normalized<class_Environment_property_glow_normalized>` | ``false`` |
@@ -137,7 +141,7 @@ Properties
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`float<class_float>` | :ref:`sdfgi_cascade0_distance<class_Environment_property_sdfgi_cascade0_distance>` | ``12.8`` |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`SDFGICascades<enum_Environment_SDFGICascades>` | :ref:`sdfgi_cascades<class_Environment_property_sdfgi_cascades>` | ``1`` |
| :ref:`int<class_int>` | :ref:`sdfgi_cascades<class_Environment_property_sdfgi_cascades>` | ``6`` |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`bool<class_bool>` | :ref:`sdfgi_enabled<class_Environment_property_sdfgi_enabled>` | ``false`` |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
@@ -191,6 +195,16 @@ Properties
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`float<class_float>` | :ref:`ssao_sharpness<class_Environment_property_ssao_sharpness>` | ``0.98`` |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`bool<class_bool>` | :ref:`ssil_enabled<class_Environment_property_ssil_enabled>` | ``false`` |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`float<class_float>` | :ref:`ssil_intensity<class_Environment_property_ssil_intensity>` | ``1.0`` |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`float<class_float>` | :ref:`ssil_normal_rejection<class_Environment_property_ssil_normal_rejection>` | ``1.0`` |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`float<class_float>` | :ref:`ssil_radius<class_Environment_property_ssil_radius>` | ``5.0`` |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`float<class_float>` | :ref:`ssil_sharpness<class_Environment_property_ssil_sharpness>` | ``0.98`` |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`float<class_float>` | :ref:`tonemap_exposure<class_Environment_property_tonemap_exposure>` | ``1.0`` |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------+
| :ref:`ToneMapper<enum_Environment_ToneMapper>` | :ref:`tonemap_mode<class_Environment_property_tonemap_mode>` | ``0`` |
@@ -356,24 +370,6 @@ enum **GlowBlendMode**:
----
.. _enum_Environment_SDFGICascades:
.. _class_Environment_constant_SDFGI_CASCADES_4:
.. _class_Environment_constant_SDFGI_CASCADES_6:
.. _class_Environment_constant_SDFGI_CASCADES_8:
enum **SDFGICascades**:
- **SDFGI_CASCADES_4** = **0**
- **SDFGI_CASCADES_6** = **1**
- **SDFGI_CASCADES_8** = **2**
----
.. _enum_Environment_SDFGIYScale:
.. _class_Environment_constant_SDFGI_Y_SCALE_DISABLED:
@@ -1039,6 +1035,38 @@ The intensity of the 7th level of glow. This is the most "global" level (blurrie
----
.. _class_Environment_property_glow_map:
- :ref:`Texture<class_Texture>` **glow_map**
+----------+---------------------+
| *Setter* | set_glow_map(value) |
+----------+---------------------+
| *Getter* | get_glow_map() |
+----------+---------------------+
The texture that should be used as a glow map to *multiply* the resulting glow color according to :ref:`glow_map_strength<class_Environment_property_glow_map_strength>`. This can be used to create a "lens dirt" effect. The texture's RGB color channels are used for modulation, but the alpha channel is ignored.
\ **Note:** The texture will be stretched to fit the screen. Therefore, it's recommended to use a texture with an aspect ratio that matches your project's base aspect ratio (typically 16:9).
----
.. _class_Environment_property_glow_map_strength:
- :ref:`float<class_float>` **glow_map_strength**
+-----------+------------------------------+
| *Default* | ``0.8`` |
+-----------+------------------------------+
| *Setter* | set_glow_map_strength(value) |
+-----------+------------------------------+
| *Getter* | get_glow_map_strength() |
+-----------+------------------------------+
How strong of an impact the :ref:`glow_map<class_Environment_property_glow_map>` should have on the overall glow effect. A strength of ``0.0`` means the glow map has no effect on the overall glow effect. A strength of ``1.0`` means the glow has a full effect on the overall glow effect (and can turn off glow entirely in specific areas of the screen if the glow map has black areas).
----
.. _class_Environment_property_glow_mix:
- :ref:`float<class_float>` **glow_mix**
@@ -1129,16 +1157,18 @@ The strength of the glow effect. This applies as the glow is blurred across the
.. _class_Environment_property_sdfgi_cascades:
- :ref:`SDFGICascades<enum_Environment_SDFGICascades>` **sdfgi_cascades**
- :ref:`int<class_int>` **sdfgi_cascades**
+-----------+---------------------------+
| *Default* | ``1`` |
| *Default* | ``6`` |
+-----------+---------------------------+
| *Setter* | set_sdfgi_cascades(value) |
+-----------+---------------------------+
| *Getter* | get_sdfgi_cascades() |
+-----------+---------------------------+
The number of cascades to use for SDFGI (between 1 and 8). A higher number of cascades allows displaying SDFGI further away while preserving detail up close, at the cost of performance. When using SDFGI on small-scale levels, :ref:`sdfgi_cascades<class_Environment_property_sdfgi_cascades>` can often be decreased between ``1`` and ``4`` to improve performance.
----
.. _class_Environment_property_sdfgi_enabled:
@@ -1153,11 +1183,11 @@ The strength of the glow effect. This applies as the glow is blurred across the
| *Getter* | is_sdfgi_enabled() |
+-----------+--------------------------+
If ``true``, enables signed distance field global illumination for meshes that have their :ref:`GeometryInstance3D.gi_mode<class_GeometryInstance3D_property_gi_mode>` set to :ref:`GeometryInstance3D.GI_MODE_BAKED<class_GeometryInstance3D_constant_GI_MODE_BAKED>`. SDFGI is a real-time global illumination technique that works well with procedurally generated and user-built levels, including in situations where geometry is created during gameplay. The signed distance field is automatically generated around the camera as it moves. Dynamic lights are supported, but dynamic occluders and emissive surfaces are not.
If ``true``, enables signed distance field global illumination for meshes that have their :ref:`GeometryInstance3D.gi_mode<class_GeometryInstance3D_property_gi_mode>` set to :ref:`GeometryInstance3D.GI_MODE_STATIC<class_GeometryInstance3D_constant_GI_MODE_STATIC>`. SDFGI is a real-time global illumination technique that works well with procedurally generated and user-built levels, including in situations where geometry is created during gameplay. The signed distance field is automatically generated around the camera as it moves. Dynamic lights are supported, but dynamic occluders and emissive surfaces are not.
**Performance:** SDFGI is relatively demanding on the GPU and is not suited to low-end hardware such as integrated graphics (consider :ref:`LightmapGI<class_LightmapGI>` instead). To improve SDFGI performance, enable :ref:`ProjectSettings.rendering/global_illumination/gi/use_half_resolution<class_ProjectSettings_property_rendering/global_illumination/gi/use_half_resolution>` in the Project Settings.
\ **Performance:** SDFGI is relatively demanding on the GPU and is not suited to low-end hardware such as integrated graphics (consider :ref:`LightmapGI<class_LightmapGI>` instead). To improve SDFGI performance, enable :ref:`ProjectSettings.rendering/global_illumination/gi/use_half_resolution<class_ProjectSettings_property_rendering/global_illumination/gi/use_half_resolution>` in the Project Settings.
**Note:** Meshes should have sufficiently thick walls to avoid light leaks (avoid one-sided walls). For interior levels, enclose your level geometry in a sufficiently large box and bridge the loops to close the mesh.
\ **Note:** Meshes should have sufficiently thick walls to avoid light leaks (avoid one-sided walls). For interior levels, enclose your level geometry in a sufficiently large box and bridge the loops to close the mesh.
----
@@ -1535,7 +1565,87 @@ The distance at which objects can occlude each other when calculating screen-spa
| *Getter* | get_ssao_sharpness() |
+-----------+---------------------------+
Sharpness refers to the amount that the screen-space ambient occlusion effect is allowed to blur over the edges of objects. Setting too high will result in aliasing around the edges of objects. Setting too low will make object edges appear blurry.
The amount that the screen-space ambient occlusion effect is allowed to blur over the edges of objects. Setting too high will result in aliasing around the edges of objects. Setting too low will make object edges appear blurry.
----
.. _class_Environment_property_ssil_enabled:
- :ref:`bool<class_bool>` **ssil_enabled**
+-----------+-------------------------+
| *Default* | ``false`` |
+-----------+-------------------------+
| *Setter* | set_ssil_enabled(value) |
+-----------+-------------------------+
| *Getter* | is_ssil_enabled() |
+-----------+-------------------------+
If ``true``, the screen-space indirect lighting effect is enabled. Screen space indirect lighting is a form of indirect lighting that allows diffuse light to bounce between nearby objects. Screen-space indirect lighting works very similarly to screen-space ambient occlusion, in that it only affects a limited range. It is intended to be used along with a form of proper global illumination like SDFGI or :ref:`VoxelGI<class_VoxelGI>`. Screen-space indirect lighting is not affected by individual light's :ref:`Light3D.light_indirect_energy<class_Light3D_property_light_indirect_energy>`.
----
.. _class_Environment_property_ssil_intensity:
- :ref:`float<class_float>` **ssil_intensity**
+-----------+---------------------------+
| *Default* | ``1.0`` |
+-----------+---------------------------+
| *Setter* | set_ssil_intensity(value) |
+-----------+---------------------------+
| *Getter* | get_ssil_intensity() |
+-----------+---------------------------+
The brightness multiplier for the screen-space indirect lighting effect. A higher value will result in brighter light.
----
.. _class_Environment_property_ssil_normal_rejection:
- :ref:`float<class_float>` **ssil_normal_rejection**
+-----------+----------------------------------+
| *Default* | ``1.0`` |
+-----------+----------------------------------+
| *Setter* | set_ssil_normal_rejection(value) |
+-----------+----------------------------------+
| *Getter* | get_ssil_normal_rejection() |
+-----------+----------------------------------+
Amount of normal rejection used when calculating screen-space indirect lighting. Normal rejection uses the normal of a given sample point to reject samples that are facing away from the current pixel. Normal rejection is necessary to avoid light leaking when only one side of an object is illuminated. However, normal rejection can be disabled if light leaking is desirable, such as when the scene mostly contains emissive objects that emit light from faces that cannot be seen from the camera.
----
.. _class_Environment_property_ssil_radius:
- :ref:`float<class_float>` **ssil_radius**
+-----------+------------------------+
| *Default* | ``5.0`` |
+-----------+------------------------+
| *Setter* | set_ssil_radius(value) |
+-----------+------------------------+
| *Getter* | get_ssil_radius() |
+-----------+------------------------+
The distance that bounced lighting can travel when using the screen space indirect lighting effect. A larger value will result in light bouncing further in a scene, but may result in under-sampling artifacts which look like long spikes surrounding light sources.
----
.. _class_Environment_property_ssil_sharpness:
- :ref:`float<class_float>` **ssil_sharpness**
+-----------+---------------------------+
| *Default* | ``0.98`` |
+-----------+---------------------------+
| *Setter* | set_ssil_sharpness(value) |
+-----------+---------------------------+
| *Getter* | get_ssil_sharpness() |
+-----------+---------------------------+
The amount that the screen-space indirect lighting effect is allowed to blur over the edges of objects. Setting too high will result in aliasing around the edges of objects. Setting too low will make object edges appear blurry.
----