diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2022-02-15 07:42:30 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-15 07:42:30 +0100 |
| commit | b3507ab0cdf25e470b1e4d977ed0bea32a305c1b (patch) | |
| tree | 2d6509661a25d6fafb99a0765bcff0eb8cbca1fd /doc | |
| parent | d02db6306ebcb57296dece3e8d990ae188b39aad (diff) | |
| parent | c10e97b604961700bba0f5c3b379e39a1f07acdf (diff) | |
Merge pull request #58100 from Calinou/environment-clamp-sky-contribution
Clamp environment light sky contribution to the [0.0; 1.0] range
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Environment.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index f2dbcec228..619ff06c02 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -57,7 +57,8 @@ The ambient light's energy. The higher the value, the stronger the light. </member> <member name="ambient_light_sky_contribution" type="float" setter="set_ambient_light_sky_contribution" getter="get_ambient_light_sky_contribution" default="1.0"> - Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene. + Defines the amount of light that the sky brings on the scene. A value of [code]0.0[/code] means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of [code]1.0[/code] means that [i]all[/i] the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene. + [b]Note:[/b] [member ambient_light_sky_contribution] is internally clamped between [code]0.0[/code] and [code]1.0[/code] (inclusive). </member> <member name="ambient_light_source" type="int" setter="set_ambient_source" getter="get_ambient_source" enum="Environment.AmbientSource" default="0"> </member> |