Document the Cubemap class

The documentation was partly ported over from Godot 3.2.
This commit is contained in:
Hugo Locurcio 2020-04-20 19:40:54 +02:00
parent 4e4fcbd793
commit 962d4d835b
No known key found for this signature in database
GPG Key ID: 39E8F8BE30B0A49C

View File

@ -1,8 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="Cubemap" inherits="TextureLayered" version="4.0"> <class name="Cubemap" inherits="TextureLayered" version="4.0">
<brief_description> <brief_description>
6-sided texture typically used in 3D rendering.
</brief_description> </brief_description>
<description> <description>
A cubemap is a 6-sided texture typically used for faking reflections in 3D rendering. 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.
[b]Note:[/b] Godot doesn't support using cubemaps as 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 cube map to an equirectangular sky map.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>