class_panoramasky.rst 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  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 PanoramaSky.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_PanoramaSky:
  6. PanoramaSky
  7. ===========
  8. **Inherits:** :ref:`Sky<class_Sky>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. A type of :ref:`Sky<class_Sky>` used to draw a background texture.
  13. Properties
  14. ----------
  15. +-------------------------------+------------------------------------------------------+
  16. | :ref:`Texture<class_Texture>` | :ref:`panorama<class_PanoramaSky_property_panorama>` |
  17. +-------------------------------+------------------------------------------------------+
  18. Description
  19. -----------
  20. 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.
  21. Property Descriptions
  22. ---------------------
  23. .. _class_PanoramaSky_property_panorama:
  24. - :ref:`Texture<class_Texture>` **panorama**
  25. +----------+---------------------+
  26. | *Setter* | set_panorama(value) |
  27. +----------+---------------------+
  28. | *Getter* | get_panorama() |
  29. +----------+---------------------+
  30. :ref:`Texture<class_Texture>` to be applied to the PanoramaSky.