diff options
| author | 20kdc <asdd2808@gmail.com> | 2022-09-28 14:06:14 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-28 09:06:14 -0400 |
| commit | b1233056b76aa803123cc304d323887ad5fdfbae (patch) | |
| tree | e8e1417a20614347f2ca9bee32f12c7d63294825 /doc | |
| parent | 0251b01da66a67ed84f8d27c33aa35f34aaca237 (diff) | |
| download | minetest-b1233056b76aa803123cc304d323887ad5fdfbae.tar.xz | |
Add zstd compression support (#12515)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/client_lua_api.txt | 19 | ||||
| -rw-r--r-- | doc/lua_api.txt | 8 |
2 files changed, 19 insertions, 8 deletions
diff --git a/doc/client_lua_api.txt b/doc/client_lua_api.txt index c789e8ca3..87d2a2c5f 100644 --- a/doc/client_lua_api.txt +++ b/doc/client_lua_api.txt @@ -897,14 +897,19 @@ Call these functions only at load time! * Compress a string of data. * `method` is a string identifying the compression method to be used. * Supported compression methods: - * Deflate (zlib): `"deflate"` - * `...` indicates method-specific arguments. Currently defined arguments are: - * Deflate: `level` - Compression level, `0`-`9` or `nil`. + * Deflate (zlib): `"deflate"` + * Zstandard: `"zstd"` + * `...` indicates method-specific arguments. Currently defined arguments + are: + * Deflate: `level` - Compression level, `0`-`9` or `nil`. + * Zstandard: `level` - Compression level. Integer or `nil`. Default `3`. + Note any supported Zstandard compression level could be used here, + but these are subject to change between Zstandard versions. * `minetest.decompress(compressed_data, method, ...)`: returns data - * Decompress a string of data (using ZLib). - * See documentation on `minetest.compress()` for supported compression methods. - * currently supported. - * `...` indicates method-specific arguments. Currently, no methods use this. + * Decompress a string of data using the algorithm specified by `method`. + * See documentation on `minetest.compress()` for supported compression + methods. + * `...` indicates method-specific arguments. Currently, no methods use this * `minetest.rgba(red, green, blue[, alpha])`: returns a string * Each argument is a 8 Bit unsigned integer * Returns the ColorString from rgb or rgba values diff --git a/doc/lua_api.txt b/doc/lua_api.txt index dac242f67..10c624033 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -4910,6 +4910,8 @@ Utilities -- the amount of data in mod storage is not constrained by -- the amount of RAM available. (5.7.0) mod_storage_on_disk = true, + -- "zstd" method for compress/decompress (5.7.0) + compress_zstd = true, } * `minetest.has_feature(arg)`: returns `boolean, missing_features` @@ -6370,11 +6372,15 @@ Misc. * `method` is a string identifying the compression method to be used. * Supported compression methods: * Deflate (zlib): `"deflate"` + * Zstandard: `"zstd"` * `...` indicates method-specific arguments. Currently defined arguments are: * Deflate: `level` - Compression level, `0`-`9` or `nil`. + * Zstandard: `level` - Compression level. Integer or `nil`. Default `3`. + Note any supported Zstandard compression level could be used here, + but these are subject to change between Zstandard versions. * `minetest.decompress(compressed_data, method, ...)`: returns data - * Decompress a string of data (using ZLib). + * Decompress a string of data using the algorithm specified by `method`. * See documentation on `minetest.compress()` for supported compression methods. * `...` indicates method-specific arguments. Currently, no methods use this |