virtualx-engine/doc/classes/Cubemap.xml

<?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 (see [ReflectionProbe]) 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 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>
</class>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer. 2020-02-12 09:59:06 +01:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 14:18:53 +01:00			`<class name="Cubemap" inherits="ImageTextureLayered" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer. 2020-02-12 09:59:06 +01:00			`<brief_description>`
Document the Cubemap class The documentation was partly ported over from Godot 3.2. 2020-04-20 19:40:54 +02:00			`6-sided texture typically used in 3D rendering.`
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer. 2020-02-12 09:59:06 +01:00			`</brief_description>`
			`<description>`
Add class descriptions for Texture2DArray, CubemapArray and ImageTextureLayered, plus overhaul TextureLayered Co-authored-by: Clay John <claynjohn@gmail.com> 2022-09-08 10:19:54 +02:00			`A cubemap is made of 6 textures organized in layers. They are typically used for faking reflections (see [ReflectionProbe]) 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.`
Document the Cubemap class The documentation was partly ported over from Godot 3.2. 2020-04-20 19:40:54 +02:00			`This resource is typically used as a uniform in custom shaders. Few core Godot methods make use of Cubemap resources.`
Add class descriptions for Texture2DArray, CubemapArray and ImageTextureLayered, plus overhaul TextureLayered Co-authored-by: Clay John <claynjohn@gmail.com> 2022-09-08 10:19:54 +02:00			`[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.`
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer. 2020-02-12 09:59:06 +01:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`</class>`