Pārlūkot izejas kodu

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

Documentation for AtlasTexture.
Rémi Verschelde 8 gadi atpakaļ
vecāks
revīzija
375378b4e8
1 mainītis faili ar 6 papildinājumiem un 0 dzēšanām
  1. 6 0
      doc/classes/AtlasTexture.xml

+ 6 - 0
doc/classes/AtlasTexture.xml

@@ -1,8 +1,11 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AtlasTexture" inherits="Texture" category="Core" version="3.0.alpha.custom_build">
 <class name="AtlasTexture" inherits="Texture" category="Core" version="3.0.alpha.custom_build">
 	<brief_description>
 	<brief_description>
+		Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls.
 	</brief_description>
 	</brief_description>
 	<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>
 	</description>
 	<tutorials>
 	<tutorials>
 	</tutorials>
 	</tutorials>
@@ -54,10 +57,13 @@
 	</methods>
 	</methods>
 	<members>
 	<members>
 		<member name="atlas" type="Texture" setter="set_atlas" getter="get_atlas">
 		<member name="atlas" type="Texture" setter="set_atlas" getter="get_atlas">
+			The texture that contains the atlas. Can be any [Texture] subtype.
 		</member>
 		</member>
 		<member name="margin" type="Rect2" setter="set_margin" getter="get_margin">
 		<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>
 		<member name="region" type="Rect2" setter="set_region" getter="get_region">
 		<member name="region" type="Rect2" setter="set_region" getter="get_region">
+			The AtlasTexture's used region.
 		</member>
 		</member>
 	</members>
 	</members>
 	<constants>
 	<constants>