virtualx-engine/doc/classes/PanoramaSkyMaterial.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PanoramaSkyMaterial" inherits="Material" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A material that provides a special texture to a [Sky], usually an HDR panorama.
	</brief_description>
	<description>
		A resource referenced in a [Sky] that is used to draw a background. [PanoramaSkyMaterial] functions similar to skyboxes in other engines, except it uses an equirectangular sky map instead of a [Cubemap].
		Using an HDR panorama is strongly recommended for accurate, high-quality reflections. Godot supports the Radiance HDR ([code].hdr[/code]) and OpenEXR ([code].exr[/code]) image formats for this purpose.
		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>
	<members>
		<member name="energy_multiplier" type="float" setter="set_energy_multiplier" getter="get_energy_multiplier" default="1.0">
			The sky's overall brightness multiplier. Higher values result in a brighter sky.
		</member>
		<member name="filter" type="bool" setter="set_filtering_enabled" getter="is_filtering_enabled" default="true">
			A boolean value to determine if the background texture should be filtered or not.
		</member>
		<member name="panorama" type="Texture2D" setter="set_panorama" getter="get_panorama">
			[Texture2D] to be applied to the [PanoramaSkyMaterial].
		</member>
	</members>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 10:08:05 +02:00			`<class name="PanoramaSkyMaterial" inherits="Material" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
Improve the top docs sections of VFX classes 2023-06-24 13:19:58 +02:00			`A material that provides a special texture to a [Sky], usually an HDR panorama.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</brief_description>`
			`<description>`
Improve the top docs sections of VFX classes 2023-06-24 13:19:58 +02:00			`A resource referenced in a [Sky] that is used to draw a background. [PanoramaSkyMaterial] functions similar to skyboxes in other engines, except it uses an equirectangular sky map instead of a [Cubemap].`
Improve the PanoramaSky class documentation See https://github.com/godotengine/godot/issues/27835. 2020-02-19 21:23:27 +01:00			`Using an HDR panorama is strongly recommended for accurate, high-quality reflections. Godot supports the Radiance HDR ([code].hdr[/code]) and OpenEXR ([code].exr[/code]) image formats for this purpose.`
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			`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.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<members>`
Expose energy_multiplier to PanoramaSkyMaterial and ProceduralSkyMaterial These are needed to tweak sky exposure separately from background 2023-10-25 14:12:22 +02:00			`<member name="energy_multiplier" type="float" setter="set_energy_multiplier" getter="get_energy_multiplier" default="1.0">`
			`The sky's overall brightness multiplier. Higher values result in a brighter sky.`
			`</member>`
Add shader cache and filter variable to PanoramaSkyMaterial 2022-01-15 02:42:25 +01:00			`<member name="filter" type="bool" setter="set_filtering_enabled" getter="is_filtering_enabled" default="true">`
			`A boolean value to determine if the background texture should be filtered or not.`
			`</member>`
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			`<member name="panorama" type="Texture2D" setter="set_panorama" getter="get_panorama">`
Working sky shader implementation 2020-03-20 01:32:19 +01:00			`[Texture2D] to be applied to the [PanoramaSkyMaterial].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</member>`
			`</members>`
			`</class>`