summaryrefslogtreecommitdiff
path: root/doc/classes/PanoramaSkyMaterial.xml
blob: 21c7f295855f5accb139cfa85c5e02709ebf95f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PanoramaSkyMaterial" inherits="Material" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A [Material] used with [Sky] to draw a background texture.
	</brief_description>
	<description>
		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">
			[Texture2D] to be applied to the [PanoramaSkyMaterial].
		</member>
	</members>
</class>