godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix Image.compress description

Browse Source 
Description mentioned `mode` instead of `source`

(cherry picked from commit 6312fe2fae)
This commit is contained in:
Ninni Pipping 2023-04-13 10:05:23 +02:00 committed by Yuri Sizov
parent ebcc7b4b98
commit 3fcaffc96b
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" />
<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>