diff options
| author | bruvzg <7645683+bruvzg@users.noreply.github.com> | 2023-03-29 09:31:25 +0300 |
|---|---|---|
| committer | bruvzg <7645683+bruvzg@users.noreply.github.com> | 2023-03-29 22:43:36 +0300 |
| commit | 0e4bd964cc60a199b22ae0621c81c804c74b7964 (patch) | |
| tree | a644fa80581923d6daca2a4c03e3218fcce0470a /doc/classes/PackedByteArray.xml | |
| parent | c29866dbc05694594b9be68b8d451816c7a0889d (diff) | |
| download | redot-engine-0e4bd964cc60a199b22ae0621c81c804c74b7964.tar.gz | |
Expose brotli decompression to the scripting API.
Diffstat (limited to 'doc/classes/PackedByteArray.xml')
| -rw-r--r-- | doc/classes/PackedByteArray.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index a3f23fa7ae..431ccf634c 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -181,7 +181,7 @@ <param index="0" name="max_output_size" type="int" /> <param index="1" name="compression_mode" type="int" default="0" /> <description> - Returns a new [PackedByteArray] with the data decompressed. Set the compression mode using one of [enum FileAccess.CompressionMode]'s constants. [b]This method only accepts gzip and deflate compression modes.[/b] + Returns a new [PackedByteArray] with the data decompressed. Set the compression mode using one of [enum FileAccess.CompressionMode]'s constants. [b]This method only accepts brotli, gzip, and deflate compression modes.[/b] This method is potentially slower than [code]decompress[/code], as it may have to re-allocate its output buffer multiple times while decompressing, whereas [code]decompress[/code] knows it's output buffer size from the beginning. GZIP has a maximal compression ratio of 1032:1, meaning it's very possible for a small compressed payload to decompress to a potentially very large output. To guard against this, you may provide a maximum size this function is allowed to allocate in bytes via [param max_output_size]. Passing -1 will allow for unbounded output. If any positive value is passed, and the decompression exceeds that amount in bytes, then an error will be returned. </description> |