summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-04-17 16:04:32 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-04-17 16:04:32 +0200
commit5497cec7a1c6e724f979b506a53bb07b5f71ce17 (patch)
tree029faa061f452a85c8070103b556f11e45ffbf70
parent32f95c2f8782f7e524310b4c040f86cb475fdab2 (diff)
Document image size limits
This closes #30238.
-rw-r--r--doc/classes/Image.xml1
-rw-r--r--doc/classes/ImageTexture.xml1
2 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml
index f541b0ae66..8cffe07fc0 100644
--- a/doc/classes/Image.xml
+++ b/doc/classes/Image.xml
@@ -5,6 +5,7 @@
</brief_description>
<description>
Native image datatype. Contains image data, which can be converted to a [Texture2D], and several functions to interact with it. The maximum width and height for an [Image] are [constant MAX_WIDTH] and [constant MAX_HEIGHT].
+ [b]Note:[/b] The maximum image size is 16384×16384 pixels due to graphics hardware limitations. Larger images will fail to import.
</description>
<tutorials>
</tutorials>
diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml
index 1578783b8b..d122d74e85 100644
--- a/doc/classes/ImageTexture.xml
+++ b/doc/classes/ImageTexture.xml
@@ -5,6 +5,7 @@
</brief_description>
<description>
A [Texture2D] based on an [Image]. Can be created from an [Image] with [method create_from_image].
+ [b]Note:[/b] The maximum image size is 16384×16384 pixels due to graphics hardware limitations. Larger images will fail to import.
</description>
<tutorials>
</tutorials>