:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ProceduralSkyMaterial.xml. .. _class_ProceduralSkyMaterial: ProceduralSkyMaterial ===================== **Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` A material that defines a simple sky for a :ref:`Sky` resource. .. rst-class:: classref-introduction-group 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 :ref:`DirectionalLight3D` nodes in the scene. This means that the suns are defined individually by the properties of their corresponding :ref:`DirectionalLight3D`\ s and globally by :ref:`sun_angle_max` and :ref:`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 :ref:`PhysicalSkyMaterial`. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`float` | :ref:`energy_multiplier` | ``1.0`` | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`Color` | :ref:`ground_bottom_color` | ``Color(0.2, 0.169, 0.133, 1)`` | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`float` | :ref:`ground_curve` | ``0.02`` | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`float` | :ref:`ground_energy_multiplier` | ``1.0`` | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`Color` | :ref:`ground_horizon_color` | ``Color(0.6463, 0.6558, 0.6708, 1)`` | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`Texture2D` | :ref:`sky_cover` | | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`Color` | :ref:`sky_cover_modulate` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`float` | :ref:`sky_curve` | ``0.15`` | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`float` | :ref:`sky_energy_multiplier` | ``1.0`` | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`Color` | :ref:`sky_horizon_color` | ``Color(0.6463, 0.6558, 0.6708, 1)`` | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`Color` | :ref:`sky_top_color` | ``Color(0.385, 0.454, 0.55, 1)`` | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`float` | :ref:`sun_angle_max` | ``30.0`` | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`float` | :ref:`sun_curve` | ``0.15`` | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ | :ref:`bool` | :ref:`use_debanding` | ``true`` | +-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ProceduralSkyMaterial_property_energy_multiplier: .. rst-class:: classref-property :ref:`float` **energy_multiplier** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_energy_multiplier**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_energy_multiplier**\ (\ ) The sky's overall brightness multiplier. Higher values result in a brighter sky. .. rst-class:: classref-item-separator ---- .. _class_ProceduralSkyMaterial_property_ground_bottom_color: .. rst-class:: classref-property :ref:`Color` **ground_bottom_color** = ``Color(0.2, 0.169, 0.133, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_ground_bottom_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_ground_bottom_color**\ (\ ) Color of the ground at the bottom. Blends with :ref:`ground_horizon_color`. .. rst-class:: classref-item-separator ---- .. _class_ProceduralSkyMaterial_property_ground_curve: .. rst-class:: classref-property :ref:`float` **ground_curve** = ``0.02`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_ground_curve**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_ground_curve**\ (\ ) How quickly the :ref:`ground_horizon_color` fades into the :ref:`ground_bottom_color`. .. rst-class:: classref-item-separator ---- .. _class_ProceduralSkyMaterial_property_ground_energy_multiplier: .. rst-class:: classref-property :ref:`float` **ground_energy_multiplier** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_ground_energy_multiplier**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_ground_energy_multiplier**\ (\ ) Multiplier for ground color. A higher value will make the ground brighter. .. rst-class:: classref-item-separator ---- .. _class_ProceduralSkyMaterial_property_ground_horizon_color: .. rst-class:: classref-property :ref:`Color` **ground_horizon_color** = ``Color(0.6463, 0.6558, 0.6708, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_ground_horizon_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_ground_horizon_color**\ (\ ) Color of the ground at the horizon. Blends with :ref:`ground_bottom_color`. .. rst-class:: classref-item-separator ---- .. _class_ProceduralSkyMaterial_property_sky_cover: .. rst-class:: classref-property :ref:`Texture2D` **sky_cover** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sky_cover**\ (\ value\: :ref:`Texture2D`\ ) - :ref:`Texture2D` **get_sky_cover**\ (\ ) The sky cover texture to use. This texture must use an equirectangular projection (similar to :ref:`PanoramaSkyMaterial`). The texture's colors will be *added* to the existing sky color, and will be multiplied by :ref:`sky_energy_multiplier` and :ref:`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). .. rst-class:: classref-item-separator ---- .. _class_ProceduralSkyMaterial_property_sky_cover_modulate: .. rst-class:: classref-property :ref:`Color` **sky_cover_modulate** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sky_cover_modulate**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_sky_cover_modulate**\ (\ ) The tint to apply to the :ref:`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 :ref:`sky_cover`. .. rst-class:: classref-item-separator ---- .. _class_ProceduralSkyMaterial_property_sky_curve: .. rst-class:: classref-property :ref:`float` **sky_curve** = ``0.15`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sky_curve**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_sky_curve**\ (\ ) How quickly the :ref:`sky_horizon_color` fades into the :ref:`sky_top_color`. .. rst-class:: classref-item-separator ---- .. _class_ProceduralSkyMaterial_property_sky_energy_multiplier: .. rst-class:: classref-property :ref:`float` **sky_energy_multiplier** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sky_energy_multiplier**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_sky_energy_multiplier**\ (\ ) Multiplier for sky color. A higher value will make the sky brighter. .. rst-class:: classref-item-separator ---- .. _class_ProceduralSkyMaterial_property_sky_horizon_color: .. rst-class:: classref-property :ref:`Color` **sky_horizon_color** = ``Color(0.6463, 0.6558, 0.6708, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sky_horizon_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_sky_horizon_color**\ (\ ) Color of the sky at the horizon. Blends with :ref:`sky_top_color`. .. rst-class:: classref-item-separator ---- .. _class_ProceduralSkyMaterial_property_sky_top_color: .. rst-class:: classref-property :ref:`Color` **sky_top_color** = ``Color(0.385, 0.454, 0.55, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sky_top_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_sky_top_color**\ (\ ) Color of the sky at the top. Blends with :ref:`sky_horizon_color`. .. rst-class:: classref-item-separator ---- .. _class_ProceduralSkyMaterial_property_sun_angle_max: .. rst-class:: classref-property :ref:`float` **sun_angle_max** = ``30.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sun_angle_max**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_sun_angle_max**\ (\ ) Distance from center of sun where it fades out completely. .. rst-class:: classref-item-separator ---- .. _class_ProceduralSkyMaterial_property_sun_curve: .. rst-class:: classref-property :ref:`float` **sun_curve** = ``0.15`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_sun_curve**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_sun_curve**\ (\ ) How quickly the sun fades away between the edge of the sun disk and :ref:`sun_angle_max`. .. rst-class:: classref-item-separator ---- .. _class_ProceduralSkyMaterial_property_use_debanding: .. rst-class:: classref-property :ref:`bool` **use_debanding** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_use_debanding**\ (\ value\: :ref:`bool`\ ) - :ref:`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. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`