diff options
| author | Ninni Pipping <over999ships@gmail.com> | 2023-04-13 10:05:23 +0200 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2023-04-24 16:52:25 +0200 |
| commit | 3fcaffc96bc00dedf350a0106ee44c74241efc80 (patch) | |
| tree | 0e090c063745ae93dc0d96156c89e96317b18e64 | |
| parent | ebcc7b4b9883c287d5e90551b6a0704e74b71d6c (diff) | |
Fix `Image.compress` description
Description mentioned `mode` instead of `source`
(cherry picked from commit 6312fe2fae92718560b06c114803b18008a50839)
| -rw-r--r-- | doc/classes/Image.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 09911d58a8..896f9f9cf5 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> |