Skip to content

Commit

Permalink
Document the Cubemap class
Browse files Browse the repository at this point in the history
The documentation was partly ported over from Godot 3.2.
  • Loading branch information
Calinou committed Apr 20, 2020
1 parent 4e4fcbd commit 962d4d8
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/classes/Cubemap.xml
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Cubemap" inherits="TextureLayered" 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>
Expand Down

0 comments on commit 962d4d8

Please sign in to comment.