Documentation for AtlasTexture.

This commit is contained in:
Julian Murgia 2017-09-09 09:26:17 +02:00
parent 7f40734a1c
commit b7a0a77f4f
1 changed files with 27 additions and 20 deletions

View File

@ -6390,8 +6390,11 @@
</class>
<class name="AtlasTexture" inherits="Texture" category="Core">
<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>
<methods>
<method name="get_atlas" qualifiers="const">
@ -6439,10 +6442,13 @@
</methods>
<members>
<member name="atlas" type="Texture" setter="set_atlas" getter="get_atlas" brief="">
The texture that contains the atlas. Can be any Texture subtype.
</member>
<member name="margin" type="Rect2" setter="set_margin" getter="get_margin" brief="">
The margin around the region. The Rect2's 'w' (width) and 'h' (height) resize the texture so it fits within the margin.
</member>
<member name="region" type="Rect2" setter="set_region" getter="get_region" brief="">
The AtlasTexture's used region.
</member>
</members>
<constants>
@ -50192,8 +50198,9 @@
- Border width (individual width for each border)
- Rounded corners (individual radius for each corner)
- Shadow
About corner radius:
Setting corner radius to high values is allowed. As soon as corners would overlap the stylebox will switch to a relative system. Example:
You may use high values for 'corner radius'. As soon as corners would overlap the stylebox will switch to a relative system. Example:
[codeblock]
height = 30
corner_radius_top_left = 50