class_panoramasky.rst 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the PanoramaSky.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_PanoramaSky:
  5. PanoramaSky
  6. ===========
  7. **Inherits:** :ref:`Sky<class_Sky>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. A type of :ref:`Sky<class_Sky>` used to draw a background texture.
  12. Properties
  13. ----------
  14. +-------------------------------+---------------------------------------------+
  15. | :ref:`Texture<class_Texture>` | :ref:`panorama<class_PanoramaSky_panorama>` |
  16. +-------------------------------+---------------------------------------------+
  17. Description
  18. -----------
  19. A resource referenced in an :ref:`Environment<class_Environment>` that is used to draw a background. The Panorama sky functions similar to skyboxes in other engines except it uses a equirectangular sky map instead of a cube map.
  20. Property Descriptions
  21. ---------------------
  22. .. _class_PanoramaSky_panorama:
  23. - :ref:`Texture<class_Texture>` **panorama**
  24. +----------+---------------------+
  25. | *Setter* | set_panorama(value) |
  26. +----------+---------------------+
  27. | *Getter* | get_panorama() |
  28. +----------+---------------------+
  29. :ref:`Texture<class_Texture>` to be applied to the PanoramaSky.