Quellcode durchsuchen

Improve documentation for AtlasTexture

(cherry picked from commit 682286fec8bfb5a2001031178effd1581d0f4a0d)
Aaron Franke vor 4 Jahren
Ursprung
Commit
d82c01c1a0
1 geänderte Dateien mit 3 neuen und 2 gelöschten Zeilen
  1. 3 2
      doc/classes/AtlasTexture.xml

+ 3 - 2
doc/classes/AtlasTexture.xml

@@ -1,10 +1,11 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="AtlasTexture" inherits="Texture" version="3.2">
 	<brief_description>
-		Packs multiple small textures in a single, bigger one. Helps to optimize video memory costs and render calls.
+		Crops out one part of a texture, such as a texture from a texture atlas.
 	</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.
+		[Texture] resource that crops out one part of the [member atlas] texture, defined by [member region]. The main use case is cropping out textures from a texture atlas, which is a big texture file that packs multiple smaller textures. Consists of a [Texture] for the [member atlas], a [member region] that defines the area of [member atlas] to use, and a [member margin] that defines the border width.
+		[AtlasTexture] cannot be used in an [AnimatedTexture], cannot be tiled in nodes such as [TextureRect], and does not work properly if used inside of other [AtlasTexture] resources. Multiple [AtlasTexture] resources can be used to crop multiple textures from the atlas. Using a texture atlas helps to optimize video memory costs and render calls compared to using multiple small files.
 		[b]Note:[/b] AtlasTextures don't support repetition. The [constant Texture.FLAG_REPEAT] and [constant Texture.FLAG_MIRRORED_REPEAT] flags are ignored when using an AtlasTexture.
 	</description>
 	<tutorials>