virtualx-engine/doc/classes/LargeTexture.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="LargeTexture" inherits="Texture2D" version="4.0">
	<brief_description>
		A [Texture2D] capable of storing many smaller textures with offsets.
	</brief_description>
	<description>
		A [Texture2D] capable of storing many smaller textures with offsets.
		You can dynamically add pieces ([Texture2D]s) to this [LargeTexture] using different offsets.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_piece">
			<return type="int">
			</return>
			<argument index="0" name="ofs" type="Vector2">
			</argument>
			<argument index="1" name="texture" type="Texture2D">
			</argument>
			<description>
				Adds [code]texture[/code] to this [LargeTexture], starting on offset [code]ofs[/code].
			</description>
		</method>
		<method name="clear">
			<return type="void">
			</return>
			<description>
				Clears the [LargeTexture].
			</description>
		</method>
		<method name="get_piece_count" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the number of pieces currently in this [LargeTexture].
			</description>
		</method>
		<method name="get_piece_offset" qualifiers="const">
			<return type="Vector2">
			</return>
			<argument index="0" name="idx" type="int">
			</argument>
			<description>
				Returns the offset of the piece with the index [code]idx[/code].
			</description>
		</method>
		<method name="get_piece_texture" qualifiers="const">
			<return type="Texture2D">
			</return>
			<argument index="0" name="idx" type="int">
			</argument>
			<description>
				Returns the [Texture2D] of the piece with the index [code]idx[/code].
			</description>
		</method>
		<method name="set_piece_offset">
			<return type="void">
			</return>
			<argument index="0" name="idx" type="int">
			</argument>
			<argument index="1" name="ofs" type="Vector2">
			</argument>
			<description>
				Sets the offset of the piece with the index [code]idx[/code] to [code]ofs[/code].
			</description>
		</method>
		<method name="set_piece_texture">
			<return type="void">
			</return>
			<argument index="0" name="idx" type="int">
			</argument>
			<argument index="1" name="texture" type="Texture2D">
			</argument>
			<description>
				Sets the [Texture2D] of the piece with index [code]idx[/code] to [code]texture[/code].
			</description>
		</method>
		<method name="set_size">
			<return type="void">
			</return>
			<argument index="0" name="size" type="Vector2">
			</argument>
			<description>
				Sets the size of this [LargeTexture].
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>