summaryrefslogtreecommitdiff
path: root/doc/classes/Cubemap.xml
blob: 01ec4c40d7b2c80d931c06c45e18a6d8bbb4cacd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Cubemap" inherits="ImageTextureLayered" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		6-sided texture typically used in 3D rendering.
	</brief_description>
	<description>
		A cubemap is made of 6 textures organized in layers. They are typically used for faking reflections in 3D rendering (see [ReflectionProbe]). It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods.
		This resource is typically used as a uniform in custom shaders. Few core Godot methods make use of [Cubemap] resources.
		To create such a texture file yourself, reimport your image files using the Godot Editor import presets.
		[b]Note:[/b] Godot doesn't support using cubemaps in a [PanoramaSkyMaterial]. You can use [url=https://danilw.github.io/GLSL-howto/cubemap_to_panorama_js/cubemap_to_panorama.html]this tool[/url] to convert a cubemap to an equirectangular sky map.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="create_placeholder" qualifiers="const">
			<return type="Resource" />
			<description>
				Creates a placeholder version of this resource ([PlaceholderCubemap]).
			</description>
		</method>
	</methods>
</class>