summaryrefslogtreecommitdiff
path: root/doc/classes/PlaceholderTexture2DArray.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2022-11-11 21:04:44 +0100
committerRémi Verschelde <rverschelde@gmail.com>2022-11-11 21:04:44 +0100
commit15a379547ea59f25f0a730608dfd82056451605b (patch)
tree90f34e9d0865492786037c998b583fbb36b6b7b2 /doc/classes/PlaceholderTexture2DArray.xml
parent340fb33e543fb5775e36a7d49d605b4e3a33e5d6 (diff)
parent17e75c830f73e259d1d1ce4fc7993e53ea7ff9a1 (diff)
Merge pull request #67856 from Calinou/doc-texture
Document Texture, CompressedTexture and Placeholder classes
Diffstat (limited to 'doc/classes/PlaceholderTexture2DArray.xml')
-rw-r--r--doc/classes/PlaceholderTexture2DArray.xml4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/classes/PlaceholderTexture2DArray.xml b/doc/classes/PlaceholderTexture2DArray.xml
index a502e5d334..a749e8c039 100644
--- a/doc/classes/PlaceholderTexture2DArray.xml
+++ b/doc/classes/PlaceholderTexture2DArray.xml
@@ -1,8 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PlaceholderTexture2DArray" inherits="PlaceholderTextureLayered" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
+ Placeholder class for a 2-dimensional texture array.
</brief_description>
<description>
+ This class is used when loading a project that uses a [Texture2D] subclass in 2 conditions:
+ - When running the project exported in dedicated server mode, only the texture's dimensions are kept (as they may be relied upon for gameplay purposes or positioning of other elements). This allows reducing the exported PCK's size significantly.
+ - When this subclass is missing due to using a different engine version or build (e.g. modules disabled).
</description>
<tutorials>
</tutorials>