asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #76018 from AThousandShips/image_doc

Browse source 
Fix `Image.compress` description
This commit is contained in:
Rémi Verschelde 2023-04-13 12:25:59 +02:00
commit 4dcf2c5431
No known key found for this signature in database
GPG key ID: C3336907360768E1
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/Image.xml
View file

@ -78,7 +78,7 @@
<param index="2" name="astc_format" type="int" enum="Image.ASTCFormat" default="0" /> <param index="2" name="astc_format" type="int" enum="Image.ASTCFormat" default="0" />
<description> <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. 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. For ASTC compression, the [param astc_format] parameter must be supplied.
</description> </description>
</method> </method>