class_sky.rst 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the Sky.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Sky:
  6. Sky
  7. ===
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`PanoramaSky<class_PanoramaSky>`, :ref:`ProceduralSky<class_ProceduralSky>`
  10. The base class for :ref:`PanoramaSky<class_PanoramaSky>` and :ref:`ProceduralSky<class_ProceduralSky>`.
  11. Description
  12. -----------
  13. The base class for :ref:`PanoramaSky<class_PanoramaSky>` and :ref:`ProceduralSky<class_ProceduralSky>`.
  14. Properties
  15. ----------
  16. +--------------------------------------------+--------------------------------------------------------+-------+
  17. | :ref:`RadianceSize<enum_Sky_RadianceSize>` | :ref:`radiance_size<class_Sky_property_radiance_size>` | ``2`` |
  18. +--------------------------------------------+--------------------------------------------------------+-------+
  19. Enumerations
  20. ------------
  21. .. _enum_Sky_RadianceSize:
  22. .. _class_Sky_constant_RADIANCE_SIZE_32:
  23. .. _class_Sky_constant_RADIANCE_SIZE_64:
  24. .. _class_Sky_constant_RADIANCE_SIZE_128:
  25. .. _class_Sky_constant_RADIANCE_SIZE_256:
  26. .. _class_Sky_constant_RADIANCE_SIZE_512:
  27. .. _class_Sky_constant_RADIANCE_SIZE_1024:
  28. .. _class_Sky_constant_RADIANCE_SIZE_2048:
  29. .. _class_Sky_constant_RADIANCE_SIZE_MAX:
  30. enum **RadianceSize**:
  31. - **RADIANCE_SIZE_32** = **0** --- Radiance texture size is 32×32 pixels.
  32. - **RADIANCE_SIZE_64** = **1** --- Radiance texture size is 64×64 pixels.
  33. - **RADIANCE_SIZE_128** = **2** --- Radiance texture size is 128×128 pixels.
  34. - **RADIANCE_SIZE_256** = **3** --- Radiance texture size is 256×256 pixels.
  35. - **RADIANCE_SIZE_512** = **4** --- Radiance texture size is 512×512 pixels.
  36. - **RADIANCE_SIZE_1024** = **5** --- Radiance texture size is 1024×1024 pixels.
  37. - **RADIANCE_SIZE_2048** = **6** --- Radiance texture size is 2048×2048 pixels.
  38. - **RADIANCE_SIZE_MAX** = **7** --- Represents the size of the :ref:`RadianceSize<enum_Sky_RadianceSize>` enum.
  39. Property Descriptions
  40. ---------------------
  41. .. _class_Sky_property_radiance_size:
  42. - :ref:`RadianceSize<enum_Sky_RadianceSize>` **radiance_size**
  43. +-----------+--------------------------+
  44. | *Default* | ``2`` |
  45. +-----------+--------------------------+
  46. | *Setter* | set_radiance_size(value) |
  47. +-----------+--------------------------+
  48. | *Getter* | get_radiance_size() |
  49. +-----------+--------------------------+
  50. The ``Sky``'s radiance map size. The higher the radiance map size, the more detailed the lighting from the ``Sky`` will be.
  51. See :ref:`RadianceSize<enum_Sky_RadianceSize>` constants for values.
  52. **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.
  53. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  54. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  55. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`