virtualx-engine/doc/classes/ProceduralSkyMaterial.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ProceduralSkyMaterial" inherits="Material" version="4.0">
	<brief_description>
		A [Material] used with [Sky] to generate a background based on user input parameters.
	</brief_description>
	<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.
		The [ProceduralSkyMaterial] supports up to 4 suns. Each sun takes its color, energy, and direction from the corresponding [DirectionalLight3D] in the scene.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="ground_bottom_color" type="Color" setter="set_ground_bottom_color" getter="get_ground_bottom_color" default="Color(0.12, 0.12, 0.13, 1)">
			Color of the ground at the bottom. Blends with [member ground_horizon_color].
		</member>
		<member name="ground_curve" type="float" setter="set_ground_curve" getter="get_ground_curve" default="0.02">
			How quickly the [member ground_horizon_color] fades into the [member ground_bottom_color].
		</member>
		<member name="ground_energy" type="float" setter="set_ground_energy" getter="get_ground_energy" default="1.0">
			Amount of energy contribution from the ground.
		</member>
		<member name="ground_horizon_color" type="Color" setter="set_ground_horizon_color" getter="get_ground_horizon_color" default="Color(0.37, 0.33, 0.31, 1)">
			Color of the ground at the horizon. Blends with [member ground_bottom_color].
		</member>
		<member name="sky_curve" type="float" setter="set_sky_curve" getter="get_sky_curve" default="0.09">
			How quickly the [member sky_horizon_color] fades into the [member sky_top_color].
		</member>
		<member name="sky_energy" type="float" setter="set_sky_energy" getter="get_sky_energy" default="1.0">
			Amount of energy contribution from the sky.
		</member>
		<member name="sky_horizon_color" type="Color" setter="set_sky_horizon_color" getter="get_sky_horizon_color" default="Color(0.55, 0.69, 0.81, 1)">
			Color of the sky at the horizon. Blends with [member sky_top_color].
		</member>
		<member name="sky_top_color" type="Color" setter="set_sky_top_color" getter="get_sky_top_color" default="Color(0.35, 0.46, 0.71, 1)">
			Color of the sky at the top. Blends with [member sky_horizon_color].
		</member>
		<member name="sun_angle_max" type="float" setter="set_sun_angle_max" getter="get_sun_angle_max" default="100.0">
			Distance from center of sun where it fades out completely.
		</member>
		<member name="sun_curve" type="float" setter="set_sun_curve" getter="get_sun_curve" default="0.05">
			How quickly the sun fades away between the edge of the sun disk and [member sun_angle_max].
		</member>
	</members>
</class>