mirror of
https://github.com/godotengine/godot
synced 2024-09-05 18:59:47 +00:00
Document PhysicalSkyMaterial's energy_multiplier
property
This makes the PhysicalSkyMaterial class 100% documented.
This commit is contained in:
parent
fa270c2456
commit
bd457348d0
|
@ -12,27 +12,28 @@
|
|||
</tutorials>
|
||||
<members>
|
||||
<member name="energy_multiplier" type="float" setter="set_energy_multiplier" getter="get_energy_multiplier" default="1.0">
|
||||
The sky's overall brightness multiplier. Higher values result in a brighter sky.
|
||||
</member>
|
||||
<member name="ground_color" type="Color" setter="set_ground_color" getter="get_ground_color" default="Color(0.1, 0.07, 0.034, 1)">
|
||||
Modulates the [Color] on the bottom half of the sky to represent the ground.
|
||||
</member>
|
||||
<member name="mie_coefficient" type="float" setter="set_mie_coefficient" getter="get_mie_coefficient" default="0.005">
|
||||
Controls the strength of mie scattering for the sky. Mie scattering results from light colliding with larger particles (like water). On earth, mie scattering results in a whitish color around the sun and horizon.
|
||||
Controls the strength of [url=https://en.wikipedia.org/wiki/Mie_scattering]Mie scattering[/url] for the sky. Mie scattering results from light colliding with larger particles (like water). On earth, Mie scattering results in a whitish color around the sun and horizon.
|
||||
</member>
|
||||
<member name="mie_color" type="Color" setter="set_mie_color" getter="get_mie_color" default="Color(0.69, 0.729, 0.812, 1)">
|
||||
Controls the [Color] of the mie scattering effect. While not physically accurate, this allows for the creation of alien-looking planets.
|
||||
Controls the [Color] of the [url=https://en.wikipedia.org/wiki/Mie_scattering]Mie scattering[/url] effect. While not physically accurate, this allows for the creation of alien-looking planets.
|
||||
</member>
|
||||
<member name="mie_eccentricity" type="float" setter="set_mie_eccentricity" getter="get_mie_eccentricity" default="0.8">
|
||||
Controls the direction of the mie scattering. A value of [code]1[/code] means that when light hits a particle it's passing through straight forward. A value of [code]-1[/code] means that all light is scatter backwards.
|
||||
Controls the direction of the [url=https://en.wikipedia.org/wiki/Mie_scattering]Mie scattering[/url]. A value of [code]1[/code] means that when light hits a particle it's passing through straight forward. A value of [code]-1[/code] means that all light is scatter backwards.
|
||||
</member>
|
||||
<member name="night_sky" type="Texture2D" setter="set_night_sky" getter="get_night_sky">
|
||||
[Texture2D] for the night sky. This is added to the sky, so if it is bright enough, it may be visible during the day.
|
||||
</member>
|
||||
<member name="rayleigh_coefficient" type="float" setter="set_rayleigh_coefficient" getter="get_rayleigh_coefficient" default="2.0">
|
||||
Controls the strength of the Rayleigh scattering. Rayleigh scattering results from light colliding with small particles. It is responsible for the blue color of the sky.
|
||||
Controls the strength of the [url=https://en.wikipedia.org/wiki/Rayleigh_scattering]Rayleigh scattering[/url]. Rayleigh scattering results from light colliding with small particles. It is responsible for the blue color of the sky.
|
||||
</member>
|
||||
<member name="rayleigh_color" type="Color" setter="set_rayleigh_color" getter="get_rayleigh_color" default="Color(0.3, 0.405, 0.6, 1)">
|
||||
Controls the [Color] of the Rayleigh scattering. While not physically accurate, this allows for the creation of alien-looking planets. For example, setting this to a red [Color] results in a Mars-looking atmosphere with a corresponding blue sunset.
|
||||
Controls the [Color] of the [url=https://en.wikipedia.org/wiki/Rayleigh_scattering]Rayleigh scattering[/url]. While not physically accurate, this allows for the creation of alien-looking planets. For example, setting this to a red [Color] results in a Mars-looking atmosphere with a corresponding blue sunset.
|
||||
</member>
|
||||
<member name="sun_disk_scale" type="float" setter="set_sun_disk_scale" getter="get_sun_disk_scale" default="1.0">
|
||||
Sets the size of the sun disk. Default value is based on Sol's perceived size from Earth.
|
||||
|
|
Loading…
Reference in a new issue