Up to date

This page is up to date for Godot 4.0. If you still find outdated information, please open an issue.

ProceduralSkyMaterial

Inherits: Material < Resource < RefCounted < Object

A Material used with Sky to generate a background based on user input parameters.

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 very similar, they are defined by a color at the horizon, another color, and finally an easing curve to interpolate between these two colors. Similarly, the sun is described by a position in the sky, a color, and an easing curve. However, the sun also defines a minimum and maximum angle, these two values define at what distance the easing curve begins and ends from the sun, and thus end up defining the size of the sun in the sky.

The ProceduralSkyMaterial uses a lightweight shader to draw the sky and is thus suited for real time updates. When you do not need a quick sky that is not realistic, this is a good option. If you need a more realistic option, try using PhysicalSkyMaterial instead.

The ProceduralSkyMaterial supports up to 4 suns. Each sun takes its color, energy, and direction from the corresponding DirectionalLight3D in the scene.

Properties

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 ( float value )

• float get_ground_energy_multiplier ( )

Multiplier for ground color. A higher value will make the ground brighter.

Color ground_horizon_color = Color(0.6463, 0.6558, 0.6708, 1)

• void set_ground_horizon_color ( Color value )

• Color get_ground_horizon_color ( )

Color of the ground at the horizon. Blends with ground_bottom_color.

Texture2D sky_cover

• void set_sky_cover ( Texture2D value )

• Texture2D get_sky_cover ( )

The sky cover texture to use. This texture must use an equirectangular projection (similar to PanoramaSkyMaterial). The texture’s colors will be added to the existing sky color, and will be multiplied by sky_energy_multiplier and sky_cover_modulate. This is mainly suited to displaying stars at night, but it can also be used to display clouds at day or night (with a non-physically-accurate look).

Color sky_cover_modulate = Color(1, 1, 1, 1)

• void set_sky_cover_modulate ( Color value )

• Color get_sky_cover_modulate ( )

The tint to apply to the sky_cover texture. This can be used to change the sky cover’s colors or opacity independently of the sky energy, which is useful for day/night or weather transitions. Only effective if a texture is defined in sky_cover.

float sky_curve = 0.15

• void set_sky_curve ( float value )

• float get_sky_curve ( )

How quickly the sky_horizon_color fades into the sky_top_color.

float sky_energy_multiplier = 1.0

• void set_sky_energy_multiplier ( float value )

• float get_sky_energy_multiplier ( )

Multiplier for sky color. A higher value will make the sky brighter.

Color sky_horizon_color = Color(0.6463, 0.6558, 0.6708, 1)

• void set_sky_horizon_color ( Color value )

• Color get_sky_horizon_color ( )

Color of the sky at the horizon. Blends with sky_top_color.

Color sky_top_color = Color(0.385, 0.454, 0.55, 1)

• void set_sky_top_color ( Color value )

• Color get_sky_top_color ( )

Color of the sky at the top. Blends with sky_horizon_color.

float sun_angle_max = 30.0

• void set_sun_angle_max ( float value )

• float get_sun_angle_max ( )

Distance from center of sun where it fades out completely.

float sun_curve = 0.15

• void set_sun_curve ( float value )

• float get_sun_curve ( )

How quickly the sun fades away between the edge of the sun disk and sun_angle_max.

bool use_debanding = true

• void set_use_debanding ( bool value )

• bool get_use_debanding ( )

If true, enables debanding. Debanding adds a small amount of noise which helps reduce banding that appears from the smooth changes in color in the sky.