Files
godot-docs-l10n/classes/es/class_proceduralskymaterial.rst
2025-12-19 14:34:07 +01:00

313 lines
17 KiB
ReStructuredText

:github_url: hide
.. _class_ProceduralSkyMaterial:
ProceduralSkyMaterial
=====================
**Hereda:** :ref:`Material<class_Material>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Un material que define un cielo simple para un recurso :ref:`Sky<class_Sky>`.
.. rst-class:: classref-introduction-group
Descripción
----------------------
**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<class_DirectionalLight3D>` nodes in the scene. This means that the suns are defined individually by the properties of their corresponding :ref:`DirectionalLight3D<class_DirectionalLight3D>`\ s and globally by :ref:`sun_angle_max<class_ProceduralSkyMaterial_property_sun_angle_max>` and :ref:`sun_curve<class_ProceduralSkyMaterial_property_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<class_PhysicalSkyMaterial>`.
.. rst-class:: classref-reftable-group
Propiedades
----------------------
.. table::
:widths: auto
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`float<class_float>` | :ref:`energy_multiplier<class_ProceduralSkyMaterial_property_energy_multiplier>` | ``1.0`` |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`Color<class_Color>` | :ref:`ground_bottom_color<class_ProceduralSkyMaterial_property_ground_bottom_color>` | ``Color(0.2, 0.169, 0.133, 1)`` |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`float<class_float>` | :ref:`ground_curve<class_ProceduralSkyMaterial_property_ground_curve>` | ``0.02`` |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`float<class_float>` | :ref:`ground_energy_multiplier<class_ProceduralSkyMaterial_property_ground_energy_multiplier>` | ``1.0`` |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`Color<class_Color>` | :ref:`ground_horizon_color<class_ProceduralSkyMaterial_property_ground_horizon_color>` | ``Color(0.6463, 0.6558, 0.6708, 1)`` |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`sky_cover<class_ProceduralSkyMaterial_property_sky_cover>` | |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`Color<class_Color>` | :ref:`sky_cover_modulate<class_ProceduralSkyMaterial_property_sky_cover_modulate>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`float<class_float>` | :ref:`sky_curve<class_ProceduralSkyMaterial_property_sky_curve>` | ``0.15`` |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`float<class_float>` | :ref:`sky_energy_multiplier<class_ProceduralSkyMaterial_property_sky_energy_multiplier>` | ``1.0`` |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`Color<class_Color>` | :ref:`sky_horizon_color<class_ProceduralSkyMaterial_property_sky_horizon_color>` | ``Color(0.6463, 0.6558, 0.6708, 1)`` |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`Color<class_Color>` | :ref:`sky_top_color<class_ProceduralSkyMaterial_property_sky_top_color>` | ``Color(0.385, 0.454, 0.55, 1)`` |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`float<class_float>` | :ref:`sun_angle_max<class_ProceduralSkyMaterial_property_sun_angle_max>` | ``30.0`` |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`float<class_float>` | :ref:`sun_curve<class_ProceduralSkyMaterial_property_sun_curve>` | ``0.15`` |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
| :ref:`bool<class_bool>` | :ref:`use_debanding<class_ProceduralSkyMaterial_property_use_debanding>` | ``true`` |
+-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descripciones de Propiedades
--------------------------------------------------------
.. _class_ProceduralSkyMaterial_property_energy_multiplier:
.. rst-class:: classref-property
:ref:`float<class_float>` **energy_multiplier** = ``1.0`` :ref:`🔗<class_ProceduralSkyMaterial_property_energy_multiplier>`
.. rst-class:: classref-property-setget
- |void| **set_energy_multiplier**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_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<class_Color>` **ground_bottom_color** = ``Color(0.2, 0.169, 0.133, 1)`` :ref:`🔗<class_ProceduralSkyMaterial_property_ground_bottom_color>`
.. rst-class:: classref-property-setget
- |void| **set_ground_bottom_color**\ (\ value\: :ref:`Color<class_Color>`\ )
- :ref:`Color<class_Color>` **get_ground_bottom_color**\ (\ )
Color del suelo en la parte inferior. Se mezcla con :ref:`ground_horizon_color<class_ProceduralSkyMaterial_property_ground_horizon_color>`.
.. rst-class:: classref-item-separator
----
.. _class_ProceduralSkyMaterial_property_ground_curve:
.. rst-class:: classref-property
:ref:`float<class_float>` **ground_curve** = ``0.02`` :ref:`🔗<class_ProceduralSkyMaterial_property_ground_curve>`
.. rst-class:: classref-property-setget
- |void| **set_ground_curve**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_ground_curve**\ (\ )
Qué tan rápido se desvanece el :ref:`ground_horizon_color<class_ProceduralSkyMaterial_property_ground_horizon_color>` en el :ref:`ground_bottom_color<class_ProceduralSkyMaterial_property_ground_bottom_color>`.
.. rst-class:: classref-item-separator
----
.. _class_ProceduralSkyMaterial_property_ground_energy_multiplier:
.. rst-class:: classref-property
:ref:`float<class_float>` **ground_energy_multiplier** = ``1.0`` :ref:`🔗<class_ProceduralSkyMaterial_property_ground_energy_multiplier>`
.. rst-class:: classref-property-setget
- |void| **set_ground_energy_multiplier**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_ground_energy_multiplier**\ (\ )
Multiplicador para el color del suelo. Un valor más alto hará que el suelo sea más brillante.
.. rst-class:: classref-item-separator
----
.. _class_ProceduralSkyMaterial_property_ground_horizon_color:
.. rst-class:: classref-property
:ref:`Color<class_Color>` **ground_horizon_color** = ``Color(0.6463, 0.6558, 0.6708, 1)`` :ref:`🔗<class_ProceduralSkyMaterial_property_ground_horizon_color>`
.. rst-class:: classref-property-setget
- |void| **set_ground_horizon_color**\ (\ value\: :ref:`Color<class_Color>`\ )
- :ref:`Color<class_Color>` **get_ground_horizon_color**\ (\ )
Color del suelo en el horizonte. Se mezcla con :ref:`ground_bottom_color<class_ProceduralSkyMaterial_property_ground_bottom_color>`.
.. rst-class:: classref-item-separator
----
.. _class_ProceduralSkyMaterial_property_sky_cover:
.. rst-class:: classref-property
:ref:`Texture2D<class_Texture2D>` **sky_cover** :ref:`🔗<class_ProceduralSkyMaterial_property_sky_cover>`
.. rst-class:: classref-property-setget
- |void| **set_sky_cover**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
- :ref:`Texture2D<class_Texture2D>` **get_sky_cover**\ (\ )
La textura de cobertura del cielo a utilizar. Esta textura debe usar una proyección equirrectangular (similar a :ref:`PanoramaSkyMaterial<class_PanoramaSkyMaterial>`). Los colores de la textura se *añadirán* al color del cielo existente, y se multiplicarán por :ref:`sky_energy_multiplier<class_ProceduralSkyMaterial_property_sky_energy_multiplier>` y :ref:`sky_cover_modulate<class_ProceduralSkyMaterial_property_sky_cover_modulate>`. Esto es principalmente adecuado para mostrar estrellas por la noche, pero también se puede utilizar para mostrar nubes de día o de noche (con un aspecto no físicamente exacto).
.. rst-class:: classref-item-separator
----
.. _class_ProceduralSkyMaterial_property_sky_cover_modulate:
.. rst-class:: classref-property
:ref:`Color<class_Color>` **sky_cover_modulate** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_ProceduralSkyMaterial_property_sky_cover_modulate>`
.. rst-class:: classref-property-setget
- |void| **set_sky_cover_modulate**\ (\ value\: :ref:`Color<class_Color>`\ )
- :ref:`Color<class_Color>` **get_sky_cover_modulate**\ (\ )
El tinte a aplicar a la textura :ref:`sky_cover<class_ProceduralSkyMaterial_property_sky_cover>`. Esto se puede usar para cambiar los colores u opacidad de la cobertura del cielo independientemente de la energía del cielo, lo cual es útil para las transiciones día/noche o climáticas. Solo es efectivo si se define una textura en :ref:`sky_cover<class_ProceduralSkyMaterial_property_sky_cover>`.
.. rst-class:: classref-item-separator
----
.. _class_ProceduralSkyMaterial_property_sky_curve:
.. rst-class:: classref-property
:ref:`float<class_float>` **sky_curve** = ``0.15`` :ref:`🔗<class_ProceduralSkyMaterial_property_sky_curve>`
.. rst-class:: classref-property-setget
- |void| **set_sky_curve**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_sky_curve**\ (\ )
La rapidez con la que el :ref:`sky_horizon_color<class_ProceduralSkyMaterial_property_sky_horizon_color>` se desvanece en el :ref:`sky_top_color<class_ProceduralSkyMaterial_property_sky_top_color>`.
.. rst-class:: classref-item-separator
----
.. _class_ProceduralSkyMaterial_property_sky_energy_multiplier:
.. rst-class:: classref-property
:ref:`float<class_float>` **sky_energy_multiplier** = ``1.0`` :ref:`🔗<class_ProceduralSkyMaterial_property_sky_energy_multiplier>`
.. rst-class:: classref-property-setget
- |void| **set_sky_energy_multiplier**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_sky_energy_multiplier**\ (\ )
Multiplicador para el color del cielo. Un valor más alto hará que el cielo sea más brillante.
.. rst-class:: classref-item-separator
----
.. _class_ProceduralSkyMaterial_property_sky_horizon_color:
.. rst-class:: classref-property
:ref:`Color<class_Color>` **sky_horizon_color** = ``Color(0.6463, 0.6558, 0.6708, 1)`` :ref:`🔗<class_ProceduralSkyMaterial_property_sky_horizon_color>`
.. rst-class:: classref-property-setget
- |void| **set_sky_horizon_color**\ (\ value\: :ref:`Color<class_Color>`\ )
- :ref:`Color<class_Color>` **get_sky_horizon_color**\ (\ )
Color del cielo en el horizonte. Se mezcla con :ref:`sky_top_color<class_ProceduralSkyMaterial_property_sky_top_color>`.
.. rst-class:: classref-item-separator
----
.. _class_ProceduralSkyMaterial_property_sky_top_color:
.. rst-class:: classref-property
:ref:`Color<class_Color>` **sky_top_color** = ``Color(0.385, 0.454, 0.55, 1)`` :ref:`🔗<class_ProceduralSkyMaterial_property_sky_top_color>`
.. rst-class:: classref-property-setget
- |void| **set_sky_top_color**\ (\ value\: :ref:`Color<class_Color>`\ )
- :ref:`Color<class_Color>` **get_sky_top_color**\ (\ )
Color del cielo en la parte superior. Se mezcla con :ref:`sky_horizon_color<class_ProceduralSkyMaterial_property_sky_horizon_color>`.
.. rst-class:: classref-item-separator
----
.. _class_ProceduralSkyMaterial_property_sun_angle_max:
.. rst-class:: classref-property
:ref:`float<class_float>` **sun_angle_max** = ``30.0`` :ref:`🔗<class_ProceduralSkyMaterial_property_sun_angle_max>`
.. rst-class:: classref-property-setget
- |void| **set_sun_angle_max**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_sun_angle_max**\ (\ )
Distancia desde el centro del sol donde se desvanece completamente.
.. rst-class:: classref-item-separator
----
.. _class_ProceduralSkyMaterial_property_sun_curve:
.. rst-class:: classref-property
:ref:`float<class_float>` **sun_curve** = ``0.15`` :ref:`🔗<class_ProceduralSkyMaterial_property_sun_curve>`
.. rst-class:: classref-property-setget
- |void| **set_sun_curve**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_sun_curve**\ (\ )
La rapidez con la que el sol se desvanece entre el borde del disco solar y :ref:`sun_angle_max<class_ProceduralSkyMaterial_property_sun_angle_max>`.
.. rst-class:: classref-item-separator
----
.. _class_ProceduralSkyMaterial_property_use_debanding:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **use_debanding** = ``true`` :ref:`🔗<class_ProceduralSkyMaterial_property_use_debanding>`
.. rst-class:: classref-property-setget
- |void| **set_use_debanding**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_use_debanding**\ (\ )
Si es ``true``, activa la reducción de bandas. La reducción de bandas añade una pequeña cantidad de ruido que ayuda a reducir las bandas que aparecen por los cambios suaves de color en el cielo.
.. |virtual| replace:: :abbr:`virtual (Normalmente, este método debería ser sobreescrito por el usuario para que tenga algún efecto.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Este método no tiene efectos secundarios. No modifica ninguna de las variables miembro de la instancia.)`
.. |vararg| replace:: :abbr:`vararg (Este método permite agregar cualquier número de argumentos después de los descritos aquí.)`
.. |constructor| replace:: :abbr:`constructor (Este método se utiliza para construir un tipo.)`
.. |static| replace:: :abbr:`static (Este método no necesita una instancia para ser llamado, por lo que puede llamarse directamente utilizando el nombre de la clase.)`
.. |operator| replace:: :abbr:`operator (Este método describe un operador válido para usar con este tipo como operando izquierdo.)`
.. |bitfield| replace:: :abbr:`BitField (Este valor es un entero compuesto como una máscara de bits de las siguientes banderas.)`
.. |void| replace:: :abbr:`void (Sin valor de retorno.)`