virtualx-engine/doc/classes/AtlasTexture.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AtlasTexture" inherits="Texture" category="Core" version="3.0-alpha">
	<brief_description>
		Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls.
	</brief_description>
	<description>
		[Texture] resource aimed at managing big textures files that pack multiple smaller textures. Consists of a [Texture], a margin that defines the border width,
		and a region that defines the actual area of the AtlasTexture.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_atlas" qualifiers="const">
			<return type="Texture">
			</return>
			<description>
			</description>
		</method>
		<method name="get_margin" qualifiers="const">
			<return type="Rect2">
			</return>
			<description>
			</description>
		</method>
		<method name="get_region" qualifiers="const">
			<return type="Rect2">
			</return>
			<description>
			</description>
		</method>
		<method name="has_filter_clip" qualifiers="const">
			<return type="bool">
			</return>
			<description>
			</description>
		</method>
		<method name="set_atlas">
			<return type="void">
			</return>
			<argument index="0" name="atlas" type="Texture">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_filter_clip">
			<return type="void">
			</return>
			<argument index="0" name="enable" type="bool">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_margin">
			<return type="void">
			</return>
			<argument index="0" name="margin" type="Rect2">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_region">
			<return type="void">
			</return>
			<argument index="0" name="region" type="Rect2">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="atlas" type="Texture" setter="set_atlas" getter="get_atlas">
			The texture that contains the atlas. Can be any [Texture] subtype.
		</member>
		<member name="filter_clip" type="bool" setter="set_filter_clip" getter="has_filter_clip">
		</member>
		<member name="margin" type="Rect2" setter="set_margin" getter="get_margin">
			The margin around the region. The [Rect2]'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin.
		</member>
		<member name="region" type="Rect2" setter="set_region" getter="get_region">
			The AtlasTexture's used region.
		</member>
	</members>
	<constants>
	</constants>
</class>