diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2021-04-15 14:02:45 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2021-04-16 17:08:36 +0200 |
| commit | 0ab928e060a8b4995d13a7f4d281d1f9b3e78cc1 (patch) | |
| tree | 74703d2cca4866a97048d4d13810f55448521e0e /doc/classes | |
| parent | 2e87857d758efb69989bc8c1cc5693f86df55d87 (diff) | |
Import: Cleanup and optimize etcpak compression method
Avoid unnecessary allocation of temporary buffers for each mip, and creates
only one Image with the compressed data.
Also renames variable and reorders code for clarity.
Clarify that squish is now only used for decompression.
Documented which formats can be decompressed in Image.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Image.xml | 3 |
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"> |