summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMax Hilbrunner <mhilbrunner@users.noreply.github.com>2021-09-16 02:41:43 +0200
committerGitHub <noreply@github.com>2021-09-16 02:41:43 +0200
commitf701d9b0f784e136106233fd87900dc4775bc7e8 (patch)
tree14829a73860403ed6442b614fa8fe9164e263704 /doc
parent47f7b4b7ca0975d7274f1004d616f383cfc6a450 (diff)
parent962d4d835b218177d4181b188b75a0b04a15f4c4 (diff)
Merge pull request #38051 from Calinou/doc-cubemap
Document the Cubemap class
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Cubemap.xml4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/classes/Cubemap.xml b/doc/classes/Cubemap.xml
index 61cb1d43f0..9e31ee8a92 100644
--- a/doc/classes/Cubemap.xml
+++ b/doc/classes/Cubemap.xml
@@ -1,8 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Cubemap" inherits="ImageTextureLayered" version="4.0">
<brief_description>
+ 6-sided texture typically used in 3D rendering.
</brief_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>
<tutorials>
</tutorials>