godot-docs/classes/class_proceduralsky.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ProceduralSky.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_ProceduralSky:

ProceduralSky
=============

**Inherits:** :ref:`Sky<class_sky>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------



Member Functions
----------------

+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`  | :ref:`get_ground_bottom_color<class_ProceduralSky_get_ground_bottom_color>`  **(** **)** const                              |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_ground_curve<class_ProceduralSky_get_ground_curve>`  **(** **)** const                                            |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_ground_energy<class_ProceduralSky_get_ground_energy>`  **(** **)** const                                          |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`  | :ref:`get_ground_horizon_color<class_ProceduralSky_get_ground_horizon_color>`  **(** **)** const                            |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_sky_curve<class_ProceduralSky_get_sky_curve>`  **(** **)** const                                                  |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_sky_energy<class_ProceduralSky_get_sky_energy>`  **(** **)** const                                                |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`  | :ref:`get_sky_horizon_color<class_ProceduralSky_get_sky_horizon_color>`  **(** **)** const                                  |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`  | :ref:`get_sky_top_color<class_ProceduralSky_get_sky_top_color>`  **(** **)** const                                          |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_sun_angle_max<class_ProceduralSky_get_sun_angle_max>`  **(** **)** const                                          |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_sun_angle_min<class_ProceduralSky_get_sun_angle_min>`  **(** **)** const                                          |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`  | :ref:`get_sun_color<class_ProceduralSky_get_sun_color>`  **(** **)** const                                                  |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_sun_curve<class_ProceduralSky_get_sun_curve>`  **(** **)** const                                                  |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_sun_energy<class_ProceduralSky_get_sun_energy>`  **(** **)** const                                                |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_sun_latitude<class_ProceduralSky_get_sun_latitude>`  **(** **)** const                                            |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_sun_longitude<class_ProceduralSky_get_sun_longitude>`  **(** **)** const                                          |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`      | :ref:`get_texture_size<class_ProceduralSky_get_texture_size>`  **(** **)** const                                            |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_ground_bottom_color<class_ProceduralSky_set_ground_bottom_color>`  **(** :ref:`Color<class_color>` color  **)**   |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_ground_curve<class_ProceduralSky_set_ground_curve>`  **(** :ref:`float<class_float>` curve  **)**                 |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_ground_energy<class_ProceduralSky_set_ground_energy>`  **(** :ref:`float<class_float>` energy  **)**              |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_ground_horizon_color<class_ProceduralSky_set_ground_horizon_color>`  **(** :ref:`Color<class_color>` color  **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_sky_curve<class_ProceduralSky_set_sky_curve>`  **(** :ref:`float<class_float>` curve  **)**                       |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_sky_energy<class_ProceduralSky_set_sky_energy>`  **(** :ref:`float<class_float>` energy  **)**                    |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_sky_horizon_color<class_ProceduralSky_set_sky_horizon_color>`  **(** :ref:`Color<class_color>` color  **)**       |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_sky_top_color<class_ProceduralSky_set_sky_top_color>`  **(** :ref:`Color<class_color>` color  **)**               |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_sun_angle_max<class_ProceduralSky_set_sun_angle_max>`  **(** :ref:`float<class_float>` degrees  **)**             |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_sun_angle_min<class_ProceduralSky_set_sun_angle_min>`  **(** :ref:`float<class_float>` degrees  **)**             |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_sun_color<class_ProceduralSky_set_sun_color>`  **(** :ref:`Color<class_color>` color  **)**                       |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_sun_curve<class_ProceduralSky_set_sun_curve>`  **(** :ref:`float<class_float>` curve  **)**                       |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_sun_energy<class_ProceduralSky_set_sun_energy>`  **(** :ref:`float<class_float>` energy  **)**                    |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_sun_latitude<class_ProceduralSky_set_sun_latitude>`  **(** :ref:`float<class_float>` degrees  **)**               |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_sun_longitude<class_ProceduralSky_set_sun_longitude>`  **(** :ref:`float<class_float>` degrees  **)**             |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_texture_size<class_ProceduralSky_set_texture_size>`  **(** :ref:`int<class_int>` size  **)**                      |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

- :ref:`Color<class_color>` **ground_bottom_color**
- :ref:`float<class_float>` **ground_curve**
- :ref:`float<class_float>` **ground_energy**
- :ref:`Color<class_color>` **ground_horizon_color**
- :ref:`float<class_float>` **sky_curve**
- :ref:`float<class_float>` **sky_energy**
- :ref:`Color<class_color>` **sky_horizon_color**
- :ref:`Color<class_color>` **sky_top_color**
- :ref:`float<class_float>` **sun_angle_max**
- :ref:`float<class_float>` **sun_angle_min**
- :ref:`Color<class_color>` **sun_color**
- :ref:`float<class_float>` **sun_curve**
- :ref:`float<class_float>` **sun_energy**
- :ref:`float<class_float>` **sun_latitude**
- :ref:`float<class_float>` **sun_longitude**
- :ref:`int<class_int>` **texture_size**

Numeric Constants
-----------------

- **TEXTURE_SIZE_256** = **0**
- **TEXTURE_SIZE_512** = **1**
- **TEXTURE_SIZE_1024** = **2**
- **TEXTURE_SIZE_2048** = **3**
- **TEXTURE_SIZE_4096** = **4**
- **TEXTURE_SIZE_MAX** = **5**

Member Function Description
---------------------------

.. _class_ProceduralSky_get_ground_bottom_color:

- :ref:`Color<class_color>`  **get_ground_bottom_color**  **(** **)** const

.. _class_ProceduralSky_get_ground_curve:

- :ref:`float<class_float>`  **get_ground_curve**  **(** **)** const

.. _class_ProceduralSky_get_ground_energy:

- :ref:`float<class_float>`  **get_ground_energy**  **(** **)** const

.. _class_ProceduralSky_get_ground_horizon_color:

- :ref:`Color<class_color>`  **get_ground_horizon_color**  **(** **)** const

.. _class_ProceduralSky_get_sky_curve:

- :ref:`float<class_float>`  **get_sky_curve**  **(** **)** const

.. _class_ProceduralSky_get_sky_energy:

- :ref:`float<class_float>`  **get_sky_energy**  **(** **)** const

.. _class_ProceduralSky_get_sky_horizon_color:

- :ref:`Color<class_color>`  **get_sky_horizon_color**  **(** **)** const

.. _class_ProceduralSky_get_sky_top_color:

- :ref:`Color<class_color>`  **get_sky_top_color**  **(** **)** const

.. _class_ProceduralSky_get_sun_angle_max:

- :ref:`float<class_float>`  **get_sun_angle_max**  **(** **)** const

.. _class_ProceduralSky_get_sun_angle_min:

- :ref:`float<class_float>`  **get_sun_angle_min**  **(** **)** const

.. _class_ProceduralSky_get_sun_color:

- :ref:`Color<class_color>`  **get_sun_color**  **(** **)** const

.. _class_ProceduralSky_get_sun_curve:

- :ref:`float<class_float>`  **get_sun_curve**  **(** **)** const

.. _class_ProceduralSky_get_sun_energy:

- :ref:`float<class_float>`  **get_sun_energy**  **(** **)** const

.. _class_ProceduralSky_get_sun_latitude:

- :ref:`float<class_float>`  **get_sun_latitude**  **(** **)** const

.. _class_ProceduralSky_get_sun_longitude:

- :ref:`float<class_float>`  **get_sun_longitude**  **(** **)** const

.. _class_ProceduralSky_get_texture_size:

- :ref:`int<class_int>`  **get_texture_size**  **(** **)** const

.. _class_ProceduralSky_set_ground_bottom_color:

- void  **set_ground_bottom_color**  **(** :ref:`Color<class_color>` color  **)**

.. _class_ProceduralSky_set_ground_curve:

- void  **set_ground_curve**  **(** :ref:`float<class_float>` curve  **)**

.. _class_ProceduralSky_set_ground_energy:

- void  **set_ground_energy**  **(** :ref:`float<class_float>` energy  **)**

.. _class_ProceduralSky_set_ground_horizon_color:

- void  **set_ground_horizon_color**  **(** :ref:`Color<class_color>` color  **)**

.. _class_ProceduralSky_set_sky_curve:

- void  **set_sky_curve**  **(** :ref:`float<class_float>` curve  **)**

.. _class_ProceduralSky_set_sky_energy:

- void  **set_sky_energy**  **(** :ref:`float<class_float>` energy  **)**

.. _class_ProceduralSky_set_sky_horizon_color:

- void  **set_sky_horizon_color**  **(** :ref:`Color<class_color>` color  **)**

.. _class_ProceduralSky_set_sky_top_color:

- void  **set_sky_top_color**  **(** :ref:`Color<class_color>` color  **)**

.. _class_ProceduralSky_set_sun_angle_max:

- void  **set_sun_angle_max**  **(** :ref:`float<class_float>` degrees  **)**

.. _class_ProceduralSky_set_sun_angle_min:

- void  **set_sun_angle_min**  **(** :ref:`float<class_float>` degrees  **)**

.. _class_ProceduralSky_set_sun_color:

- void  **set_sun_color**  **(** :ref:`Color<class_color>` color  **)**

.. _class_ProceduralSky_set_sun_curve:

- void  **set_sun_curve**  **(** :ref:`float<class_float>` curve  **)**

.. _class_ProceduralSky_set_sun_energy:

- void  **set_sun_energy**  **(** :ref:`float<class_float>` energy  **)**

.. _class_ProceduralSky_set_sun_latitude:

- void  **set_sun_latitude**  **(** :ref:`float<class_float>` degrees  **)**

.. _class_ProceduralSky_set_sun_longitude:

- void  **set_sun_longitude**  **(** :ref:`float<class_float>` degrees  **)**

.. _class_ProceduralSky_set_texture_size:

- void  **set_texture_size**  **(** :ref:`int<class_int>` size  **)**