2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-12 16:59:06 +08:00
<class name= "AtlasTexture" inherits= "Texture2D" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
2017-09-13 13:42:53 +08:00
Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2020-02-12 16:59:06 +08:00
[Texture2D] resource aimed at managing big textures files that pack multiple smaller textures. Consists of a [Texture2D], a margin that defines the border width, and a region that defines the actual area of the AtlasTexture.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
</methods>
<members >
2020-02-12 16:59:06 +08:00
<member name= "atlas" type= "Texture2D" setter= "set_atlas" getter= "get_atlas" >
The texture that contains the atlas. Can be any [Texture2D] subtype.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "filter_clip" type= "bool" setter= "set_filter_clip" getter= "has_filter_clip" default= "false" >
2018-12-20 20:46:54 +08:00
If [code]true[/code], clips the area outside of the region to avoid bleeding of the surrounding texture pixels.
2017-11-13 16:24:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "margin" type= "Rect2" setter= "set_margin" getter= "get_margin" default= "Rect2( 0, 0, 0, 0 )" >
2019-06-22 07:04:47 +08:00
The margin around the region. The [Rect2]'s [member Rect2.size] parameter ("w" and "h" in the editor) resizes the texture so it fits within the margin.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "region" type= "Rect2" setter= "set_region" getter= "get_region" default= "Rect2( 0, 0, 0, 0 )" >
2017-09-13 13:42:53 +08:00
The AtlasTexture's used region.
2017-09-13 04:42:36 +08:00
</member>
</members>
<constants >
</constants>
</class>
