Fix Image.compress description

Description mentioned `mode` instead of `source`
This commit is contained in:
Ninni Pipping 2023-04-13 10:05:23 +02:00
parent 68b8156fe3
commit 6312fe2fae

View file

@ -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>