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.

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.math.compress( rawstring, format, level )

Arguments

string rawstring

The raw (un-compressed) string to compress.

CompressedDataFormat format ("lz4")

The format to use when compressing the string.

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 use when compressing the data.

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

• love.math
• love.math.decompress
• CompressedData