summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2021-04-18 17:00:21 +0200
committerGitHub <noreply@github.com>2021-04-18 17:00:21 +0200
commitdfe4feb1884ba058f2d8938ed13221949d6cc483 (patch)
tree7286adc18768fe5ed67cde50de03e1ba0da0063e /doc/classes
parentc05245f539326cfafeaed7334b09e29db2376dd9 (diff)
parent0ab928e060a8b4995d13a7f4d281d1f9b3e78cc1 (diff)
Merge pull request #47917 from akien-mga/squish-decompress-only
Import: Cleanup and optimize etcpak compression method
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Image.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml
index 9d87c9bf9a..91a07f66e0 100644
--- a/doc/classes/Image.xml
+++ b/doc/classes/Image.xml
@@ -186,7 +186,8 @@
<return type="int" enum="Error">
</return>
<description>
- Decompresses the image if it is compressed. Returns an error if decompress function is not available.
+ Decompresses the image if it is VRAM compressed in a supported format. Returns [constant OK] if the format is supported, otherwise [constant ERR_UNAVAILABLE].
+ [b]Note:[/b] The following formats can be decompressed: DXT, RGTC, BPTC, PVRTC1. The formats ETC1 and ETC2 are not supported.
</description>
</method>
<method name="detect_alpha" qualifiers="const">