Difference between revisions of "love.math.decompress"

m (This is not a CompressedData constructor.)
(the compression format is a required argument)
Line 17: Line 17:
 
=== Arguments ===
 
=== Arguments ===
 
{{param|string|compressedstring|A string containing data previously compressed with [[love.math.compress]].}}
 
{{param|string|compressedstring|A string containing data previously compressed with [[love.math.compress]].}}
{{param|CompressedDataFormat|format ("lz4")|The format that was used to compress the given string.}}
+
{{param|CompressedDataFormat|format|The format that was used to compress the given string.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|string|rawstring|A string containing the raw decompressed data.}}
 
{{param|string|rawstring|A string containing the raw decompressed data.}}
Line 27: Line 27:
 
=== Arguments ===
 
=== Arguments ===
 
{{param|Data|data|A Data object containing data previously compressed with [[love.math.compress]].}}
 
{{param|Data|data|A Data object containing data previously compressed with [[love.math.compress]].}}
{{param|CompressedDataFormat|format ("lz4")|The format that was used to compress the given data.}}
+
{{param|CompressedDataFormat|format|The format that was used to compress the given data.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|string|rawstring|A string containing the raw decompressed data.}}
 
{{param|string|rawstring|A string containing the raw decompressed data.}}

Revision as of 19:18, 25 March 2016

Available since LÖVE 0.10.0
This function is not supported in earlier versions.

Decompresses a CompressedData or previously compressed string or Data object.

Function

Synopsis

rawstring = love.math.decompress( compressedData )

Arguments

CompressedData compressedData
The compressed data to decompress.

Returns

string rawstring
A string containing the raw decompressed data.

Function

Synopsis

compressedData = love.math.decompress( compressedstring, format )

Arguments

string compressedstring
A string containing data previously compressed with love.math.compress.
CompressedDataFormat format
The format that was used to compress the given string.

Returns

string rawstring
A string containing the raw decompressed data.

Function

Synopsis

compressedData = love.math.decompress( data, format )

Arguments

Data data
A Data object containing data previously compressed with love.math.compress.
CompressedDataFormat format
The format that was used to compress the given data.

Returns

string rawstring
A string containing the raw decompressed data.

See Also

Other Languages