diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2017-09-13 20:22:59 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-13 20:22:59 +0200 |
| commit | 375378b4e8b0d3bd9463339010da90161d378a97 (patch) | |
| tree | 81e54c8140866e05a5ebdf5c677155281b4b1b48 /doc/classes/AtlasTexture.xml | |
| parent | e6a3ea1e264a3dcc11312463a654538b1e287164 (diff) | |
| parent | cb3bb2652107b4e718ab37f1f966cafd3d9fb917 (diff) | |
Merge pull request #11226 from StraToN/docssprint-atlastexture-2
Documentation for AtlasTexture.
Diffstat (limited to 'doc/classes/AtlasTexture.xml')
| -rw-r--r-- | doc/classes/AtlasTexture.xml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/classes/AtlasTexture.xml b/doc/classes/AtlasTexture.xml index 459d15a534..179f78f16f 100644 --- a/doc/classes/AtlasTexture.xml +++ b/doc/classes/AtlasTexture.xml @@ -1,8 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AtlasTexture" inherits="Texture" category="Core" version="3.0.alpha.custom_build"> <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> @@ -54,10 +57,13 @@ </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="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> |