Compresses a string or data using a specific compression algorithm.
|
This function, depending on the compression format and level, can be slow if called repeatedly, such as from love.update or love.draw. Some benchmarks are available here.
|
|
Function
Synopsis
compressedData = love.data.compress( container, format, rawstring, level )
Arguments
ContainerType container
- What type to return the compressed data as.
CompressedDataFormat format
- The format to use when compressing the string.
string rawstring
- The raw (un-compressed) string to compress.
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
value compressedData
- CompressedData/string which contains the compressed version of rawstring.
Function
Synopsis
compressedData = love.data.compress( container, format, data, level )
Arguments
ContainerType container
- What type to return the compressed data as.
CompressedDataFormat format
- The format to use when compressing the data.
Data data
- A Data object containing the raw (un-compressed) data to compress.
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
value compressedData
- CompressedData/string which contains the compressed version of data.
See Also