love.math.compress

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.

O.png 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!  



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
The level of compression to use, between 0 and 9. 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
The level of compression to use, between 0 and 9. 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