Difference between revisions of "love.math.compress"
m |
m |
||
| Line 10: | Line 10: | ||
{{param|string|rawstring|The raw (un-compressed) string to compress.}} | {{param|string|rawstring|The raw (un-compressed) string to compress.}} | ||
{{param|CompressedDataFormat|format ("lz4")|The format to compress the string to.}} | {{param|CompressedDataFormat|format ("lz4")|The format to compress the string to.}} | ||
| − | {{param|number|level|The level of compression to use, between 0 and 9. The meaning of this argument depends on the compression format being used.}} | + | {{param|number|level (-1)|The level of compression to use, between 0 and 9. -1 indicates the default level. The meaning of this argument depends on the compression format being used.}} |
=== Returns === | === Returns === | ||
{{param|CompressedData|compressedData|A new Data object containing the compressed version of the string.}} | {{param|CompressedData|compressedData|A new Data object containing the compressed version of the string.}} | ||
| Line 21: | Line 21: | ||
{{param|Data|data|A Data object containing the raw (un-compressed) data to compress.}} | {{param|Data|data|A Data object containing the raw (un-compressed) data to compress.}} | ||
{{param|CompressedDataFormat|format ("lz4")|The format to compress the data to.}} | {{param|CompressedDataFormat|format ("lz4")|The format to compress the data to.}} | ||
| − | {{param|number|level|The level of compression to use, between 0 and 9. The meaning of this argument depends on the compression format being used.}} | + | {{param|number|level (-1)|The level of compression to use, between 0 and 9. -1 indicates the default level. The meaning of this argument depends on the compression format being used.}} |
=== Returns === | === Returns === | ||
{{param|CompressedData|compressedData|A new Data object containing the compressed version of the raw data.}} | {{param|CompressedData|compressedData|A new Data object containing the compressed version of the raw data.}} | ||
Revision as of 04:12, 3 October 2015
| Available since LÖVE 0.10.0 |
| This function is not supported in earlier versions. |
Compresses a string or data using a specific compression algorithm.
|
This function can be slow if it is called repeatedly, such as from love.update or love.draw. If you need to use a specific resource often, create it once and store it somewhere it can be reused! |
Contents
Function
Synopsis
compressedData = love.math.compress( rawstring, format, level )
Arguments
string rawstring- The raw (un-compressed) string to compress.
CompressedDataFormat format ("lz4")- The format to compress the string to.
number level (-1)- The level of compression to use, between 0 and 9. -1 indicates the default level. The meaning of this argument depends on the compression format being used.
Returns
CompressedData compressedData- A new Data object containing the compressed version of the string.
Function
Synopsis
compressedData = love.math.compress( data, format, level )
Arguments
Data data- A Data object containing the raw (un-compressed) data to compress.
CompressedDataFormat format ("lz4")- The format to compress the data to.
number level (-1)- The level of compression to use, between 0 and 9. -1 indicates the default level. The meaning of this argument depends on the compression format being used.
Returns
CompressedData compressedData- A new Data object containing the compressed version of the raw data.
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
