godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #11226 from StraToN/docssprint-atlastexture-2 

Documentation for AtlasTexture.
This commit is contained in:
Rémi Verschelde 2017-09-13 20:22:59 +02:00 committed by GitHub
parent e6a3ea1e26 cb3bb26521
commit 375378b4e8
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/classes/AtlasTexture.xml
View File

@ -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>