Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

ProceduralSkyMaterial¶

Inherits: Material < Resource < RefCounted < Object

A material that defines a simple sky for a Sky resource.

Description¶

ProceduralSkyMaterial provides a way to create an effective background quickly by defining procedural parameters for the sun, the sky and the ground. The sky and ground are defined by a main color, a color at the horizon, and an easing curve to interpolate between them. Suns are described by a position in the sky, a color, and a max angle from the sun at which the easing curve ends. The max angle therefore defines the size of the sun in the sky.

ProceduralSkyMaterial supports up to 4 suns, using the color, and energy, direction, and angular distance of the first four DirectionalLight3D nodes in the scene. This means that the suns are defined individually by the properties of their corresponding DirectionalLight3Ds and globally by sun_angle_max and sun_curve.

ProceduralSkyMaterial uses a lightweight shader to draw the sky and is therefore suited for real time updates. This makes it a great option for a sky that is simple and computationally cheap, but unrealistic. If you need a more realistic procedural option, use PhysicalSkyMaterial.

Properties¶

Color	ground_bottom_color	`Color(0.2, 0.169, 0.133, 1)`
float	ground_curve	`0.02`
float	ground_energy_multiplier	`1.0`
Color	ground_horizon_color	`Color(0.6463, 0.6558, 0.6708, 1)`
Texture2D	sky_cover
Color	sky_cover_modulate	`Color(1, 1, 1, 1)`
float	sky_curve	`0.15`
float	sky_energy_multiplier	`1.0`
Color	sky_horizon_color	`Color(0.6463, 0.6558, 0.6708, 1)`
Color	sky_top_color	`Color(0.385, 0.454, 0.55, 1)`
float	sun_angle_max	`30.0`
float	sun_curve	`0.15`
bool	use_debanding	`true`

Property Descriptions¶

Color ground_bottom_color = Color(0.2, 0.169, 0.133, 1)

void set_ground_bottom_color ( Color value )
Color get_ground_bottom_color ( )

Color of the ground at the bottom. Blends with ground_horizon_color.

float ground_curve = 0.02

void set_ground_curve ( float value )
float get_ground_curve ( )

How quickly the ground_horizon_color fades into the ground_bottom_color.

float ground_energy_multiplier = 1.0

void set_ground_energy_multiplier (