{{newin|[[0.10.0]]|100|type=function}}
{{deprecatedin|[[11.0]]|110|type=function|text=This function is deprecated and is replaced by [[love.data.compress]]}}
Compresses a string or data using a specific compression algorithm.
{{notice|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 [https://github.com/Cyan4973/lz4#user-content-benchmarks here].}}
== Function ==
=== Synopsis ===
<source lang="lua">
compressedData = love.math.compress( rawstring, format, level )
</source>
=== Arguments ===
{{param|string|rawstring|The raw (un-compressed) string to compress.}}
{{param|CompressedDataFormat|format ("lz4")|The format to use when compressing the string.}}
{{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 ===
{{param|CompressedData|compressedData|A new Data object containing the compressed version of the string.}}
== Function ==
=== Synopsis ===
<source lang="lua">
compressedData = love.math.compress( data, format, level )
</source>
=== Arguments ===
{{param|Data|data|A Data object containing the raw (un-compressed) data to compress.}}
{{param|CompressedDataFormat|format ("lz4")|The format to use when compressing the data.}}
{{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 ===
{{param|CompressedData|compressedData|A new Data object containing the compressed version of the raw data.}}
== See Also ==
* [[parent::love.math]]
* [[love.math.decompress]]
* [[Constructs::CompressedData]]
[[Category:Functions]]
{{#set:Description=Compresses a string or data using a specific compression algorithm.}}
== Other Languages ==
{{i18n|love.math.compress}}