summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2023-04-13 12:25:59 +0200
committerRémi Verschelde <rverschelde@gmail.com>2023-04-13 12:25:59 +0200
commit4dcf2c5431ea6894c268c384df0d81e7fd96c341 (patch)
treedbdccab133bdf96c163f89ee575a62835a7f2140
parent37991a244b66b4a12efd63e108de25a6bd5de03c (diff)
parent6312fe2fae92718560b06c114803b18008a50839 (diff)
downloadredot-engine-4dcf2c5431ea6894c268c384df0d81e7fd96c341.tar.gz
Merge pull request #76018 from AThousandShips/image_doc
Fix `Image.compress` description
-rw-r--r--doc/classes/Image.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml
index 613d5269dc..de7e1521f7 100644
--- a/doc/classes/Image.xml
+++ b/doc/classes/Image.xml
@@ -78,7 +78,7 @@
<param index="2" name="astc_format" type="int" enum="Image.ASTCFormat" default="0" />
<description>
Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available.
- The [param mode] parameter helps to pick the best compression method for DXT and ETC2 formats. It is ignored for ASTC compression.
+ The [param source] parameter helps to pick the best compression method for DXT and ETC2 formats. It is ignored for ASTC compression.
For ASTC compression, the [param astc_format] parameter must be supplied.
</description>
</method>