godot/doc/classes/PanoramaSkyMaterial.xml

22 lines
1.2 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
2020-03-20 00:32:19 +00:00
<class name="PanoramaSkyMaterial" inherits="Material" version="4.0">
<brief_description>
2020-03-20 00:32:19 +00:00
A [Material] used with [Sky] to draw a background texture.
</brief_description>
<description>
2020-03-20 00:32:19 +00:00
A resource referenced in a [Sky] that is used to draw a background. The Panorama sky material 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 ([code].hdr[/code]) and OpenEXR ([code].exr[/code]) image formats for this purpose.
You can use [url=https://danilw.github.io/GLSL-howto/cubemap_to_panorama_js/cubemap_to_panorama.html]this tool[/url] to convert a cube map to an equirectangular sky map.
</description>
<tutorials>
</tutorials>
<members>
<member name="filter" type="bool" setter="set_filtering_enabled" getter="is_filtering_enabled" default="true">
A boolean value to determine if the background texture should be filtered or not.
</member>
<member name="panorama" type="Texture2D" setter="set_panorama" getter="get_panorama">
2020-03-20 00:32:19 +00:00
[Texture2D] to be applied to the [PanoramaSkyMaterial].
</member>
</members>
</class>