mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
93 lines
3.3 KiB
ReStructuredText
93 lines
3.3 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||
.. DO NOT EDIT THIS FILE, but the Sky.xml source instead.
|
||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||
|
||
.. _class_Sky:
|
||
|
||
Sky
|
||
===
|
||
|
||
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||
|
||
**Inherited By:** :ref:`PanoramaSky<class_PanoramaSky>`, :ref:`ProceduralSky<class_ProceduralSky>`
|
||
|
||
The base class for :ref:`PanoramaSky<class_PanoramaSky>` and :ref:`ProceduralSky<class_ProceduralSky>`.
|
||
|
||
Description
|
||
-----------
|
||
|
||
The base class for :ref:`PanoramaSky<class_PanoramaSky>` and :ref:`ProceduralSky<class_ProceduralSky>`.
|
||
|
||
Properties
|
||
----------
|
||
|
||
+--------------------------------------------+--------------------------------------------------------+-------+
|
||
| :ref:`RadianceSize<enum_Sky_RadianceSize>` | :ref:`radiance_size<class_Sky_property_radiance_size>` | ``2`` |
|
||
+--------------------------------------------+--------------------------------------------------------+-------+
|
||
|
||
Enumerations
|
||
------------
|
||
|
||
.. _enum_Sky_RadianceSize:
|
||
|
||
.. _class_Sky_constant_RADIANCE_SIZE_32:
|
||
|
||
.. _class_Sky_constant_RADIANCE_SIZE_64:
|
||
|
||
.. _class_Sky_constant_RADIANCE_SIZE_128:
|
||
|
||
.. _class_Sky_constant_RADIANCE_SIZE_256:
|
||
|
||
.. _class_Sky_constant_RADIANCE_SIZE_512:
|
||
|
||
.. _class_Sky_constant_RADIANCE_SIZE_1024:
|
||
|
||
.. _class_Sky_constant_RADIANCE_SIZE_2048:
|
||
|
||
.. _class_Sky_constant_RADIANCE_SIZE_MAX:
|
||
|
||
enum **RadianceSize**:
|
||
|
||
- **RADIANCE_SIZE_32** = **0** --- Radiance texture size is 32×32 pixels.
|
||
|
||
- **RADIANCE_SIZE_64** = **1** --- Radiance texture size is 64×64 pixels.
|
||
|
||
- **RADIANCE_SIZE_128** = **2** --- Radiance texture size is 128×128 pixels.
|
||
|
||
- **RADIANCE_SIZE_256** = **3** --- Radiance texture size is 256×256 pixels.
|
||
|
||
- **RADIANCE_SIZE_512** = **4** --- Radiance texture size is 512×512 pixels.
|
||
|
||
- **RADIANCE_SIZE_1024** = **5** --- Radiance texture size is 1024×1024 pixels.
|
||
|
||
- **RADIANCE_SIZE_2048** = **6** --- Radiance texture size is 2048×2048 pixels.
|
||
|
||
- **RADIANCE_SIZE_MAX** = **7** --- Represents the size of the :ref:`RadianceSize<enum_Sky_RadianceSize>` enum.
|
||
|
||
Property Descriptions
|
||
---------------------
|
||
|
||
.. _class_Sky_property_radiance_size:
|
||
|
||
- :ref:`RadianceSize<enum_Sky_RadianceSize>` **radiance_size**
|
||
|
||
+-----------+--------------------------+
|
||
| *Default* | ``2`` |
|
||
+-----------+--------------------------+
|
||
| *Setter* | set_radiance_size(value) |
|
||
+-----------+--------------------------+
|
||
| *Getter* | get_radiance_size() |
|
||
+-----------+--------------------------+
|
||
|
||
The ``Sky``'s radiance map size. The higher the radiance map size, the more detailed the lighting from the ``Sky`` will be.
|
||
|
||
See :ref:`RadianceSize<enum_Sky_RadianceSize>` constants for values.
|
||
|
||
**Note:** Some hardware will have trouble with higher radiance sizes, especially :ref:`RADIANCE_SIZE_512<class_Sky_constant_RADIANCE_SIZE_512>` and above. Only use such high values on high-end hardware.
|
||
|
||
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
||
.. |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.)`
|