virtualx-engine/doc/classes/CompressedTextureLayered.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CompressedTextureLayered" inherits="TextureLayered" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Base class for texture arrays that can optionally be compressed.
	</brief_description>
	<description>
		Base class for [CompressedTexture2DArray] and [CompressedTexture3D]. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. See also [TextureLayered].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="load">
			<return type="int" enum="Error" />
			<param index="0" name="path" type="String" />
			<description>
				Loads the texture at [param path].
			</description>
		</method>
	</methods>
	<members>
		<member name="load_path" type="String" setter="load" getter="get_load_path" default="&quot;&quot;">
			The path the texture should be loaded from.
		</member>
	</members>
</class>
doc: Sync classref with current source Bind missing enums. 2020-09-11 12:22:10 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Bump version to 4.1-dev Can't stop, won't stop, they said, huh? 2023-03-01 01:44:37 +01:00			`<class name="CompressedTextureLayered" inherits="TextureLayered" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
doc: Sync classref with current source Bind missing enums. 2020-09-11 12:22:10 +02:00			`<brief_description>`
Document Texture, CompressedTexture and Placeholder classes 2022-10-24 23:19:32 +02:00			`Base class for texture arrays that can optionally be compressed.`
doc: Sync classref with current source Bind missing enums. 2020-09-11 12:22:10 +02:00			`</brief_description>`
			`<description>`
Fix CompressedTextureLayered description in the class reference This also updates the list of compression modes available for textures. 2023-03-22 22:06:55 +01:00			`Base class for [CompressedTexture2DArray] and [CompressedTexture3D]. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. See also [TextureLayered].`
doc: Sync classref with current source Bind missing enums. 2020-09-11 12:22:10 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`<method name="load">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 15:28:05 +02:00			`<return type="int" enum="Error" />`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="path" type="String" />`
doc: Sync classref with current source Bind missing enums. 2020-09-11 12:22:10 +02:00			`<description>`
Document Texture, CompressedTexture and Placeholder classes 2022-10-24 23:19:32 +02:00			`Loads the texture at [param path].`
doc: Sync classref with current source Bind missing enums. 2020-09-11 12:22:10 +02:00			`</description>`
			`</method>`
			`</methods>`
			`<members>`
			`<member name="load_path" type="String" setter="load" getter="get_load_path" default="""">`
Document Texture, CompressedTexture and Placeholder classes 2022-10-24 23:19:32 +02:00			`The path the texture should be loaded from.`
doc: Sync classref with current source Bind missing enums. 2020-09-11 12:22:10 +02:00			`</member>`
			`</members>`
			`</class>`