:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PanoramaSky.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_PanoramaSky:

PanoramaSky
===========

**Inherits:** :ref:`Sky<class_Sky>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

A type of :ref:`Sky<class_Sky>` used to draw a background texture.

Description
-----------

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 an equirectangular sky map instead of a cube map.

Using an HDR panorama is strongly recommended for accurate, high-quality reflections. Godot supports the Radiance HDR (``.hdr``) and OpenEXR (``.exr``) image formats for this purpose.

You can use `this tool <https://danilw.github.io/GLSL-howto/cubemap_to_panorama_js/cubemap_to_panorama.html>`_ to convert a cube map to an equirectangular sky map.

Properties
----------

+-------------------------------+------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`panorama<class_PanoramaSky_property_panorama>` |
+-------------------------------+------------------------------------------------------+

Property Descriptions
---------------------

.. _class_PanoramaSky_property_panorama:

- :ref:`Texture<class_Texture>` **panorama**

+----------+---------------------+
| *Setter* | set_panorama(value) |
+----------+---------------------+
| *Getter* | get_panorama()      |
+----------+---------------------+

:ref:`Texture<class_Texture>` to be applied to the PanoramaSky.

.. |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.)`