Difference between revisions of "love.data.compress"

m (Added ContainerType param)
m (¯\_(ツ)_/¯)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{newin|[[0.11.0]]|110|type=function|text=Deprecates [[love.math.compress]]}}
+
{{newin|[[11.0]]|110|type=function|text=Deprecates [[love.math.compress]]}}
 
Compresses a string or data using a specific compression algorithm.
 
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].}}
 
{{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].}}
{{notice|This is unofficial documentation. This might be not accurate!}}
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 14: Line 13:
 
{{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.}}
 
{{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 or string|compressedData|[[CompressedData]]/[[string]] which contains the compressed version of rawstring.}}
+
{{param|value|compressedData|[[CompressedData]]/[[string]] which contains the compressed version of rawstring.}}
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 26: Line 25:
 
{{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.}}
 
{{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 or string|compressedData|[[CompressedData]]/[[string]] which contains the compressed version of data.}}
+
{{param|value|compressedData|[[CompressedData]]/[[string]] which contains the compressed version of data.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.data]]
 
* [[parent::love.data]]

Latest revision as of 13:13, 2 April 2018

Available since LÖVE 11.0
Deprecates love.math.compress.

Compresses a string or data using a specific compression algorithm.

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

Other Languages