Difference between revisions of "love.data.decompress"
(Need to read LOVE source code to get the argument order. Please edit if it's incorrect.) |
m (Added ContainerType param) |
||
| Line 1: | Line 1: | ||
| − | {{newin|[[0.11.0]]|110|type=function|text= | + | {{newin|[[0.11.0]]|110|type=function|text=Deprecates [[love.math.decompress]]}} |
Decompresses a [[CompressedData]] or previously compressed string or [[Data]] object. | Decompresses a [[CompressedData]] or previously compressed string or [[Data]] object. | ||
| + | {{notice|This is unofficial documentation. This might be not accurate!}} | ||
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| − | + | decompressedData = love.data.decompress( container, compressedData ) | |
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| + | {{param|ContainerType|container|What type to return the decompressed data as.}} | ||
{{param|CompressedData|compressedData|The compressed data to decompress.}} | {{param|CompressedData|compressedData|The compressed data to decompress.}} | ||
=== Returns === | === Returns === | ||
| − | {{param|string| | + | {{param|ByteData or string|decompressedData|[[ByteData]]/[[string]] containing the raw decompressed data.}} |
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| − | + | decompressedData = love.data.decompress( container, format, compressedString ) | |
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| + | {{param|ContainerType|container|What type to return the decompressed data as.}} | ||
{{param|CompressedDataFormat|format|The format that was used to compress the given string.}} | {{param|CompressedDataFormat|format|The format that was used to compress the given string.}} | ||
| − | {{param|string| | + | {{param|string|compressedString|A string containing data previously compressed with [[love.data.compress]].}} |
=== Returns === | === Returns === | ||
| − | {{param|string| | + | {{param|ByteData or string|decompressedData|[[ByteData]]/[[string]] containing the raw decompressed data.}} |
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| − | + | decompressedData = love.data.decompress( container, format, data ) | |
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| + | {{param|ContainerType|container|What type to return the decompressed data as.}} | ||
{{param|CompressedDataFormat|format|The format that was used to compress the given data.}} | {{param|CompressedDataFormat|format|The format that was used to compress the given data.}} | ||
{{param|Data|data|A Data object containing data previously compressed with [[love.data.compress]].}} | {{param|Data|data|A Data object containing data previously compressed with [[love.data.compress]].}} | ||
=== Returns === | === Returns === | ||
| − | {{param|string| | + | {{param|ByteData or string|decompressedData|[[ByteData]]/[[string]] containing the raw decompressed data.}} |
== See Also == | == See Also == | ||
* [[parent::love.data]] | * [[parent::love.data]] | ||
Revision as of 12:53, 7 January 2018
| Available since LÖVE 0.11.0 |
| Deprecates love.math.decompress. |
Decompresses a CompressedData or previously compressed string or Data object.
|
This is unofficial documentation. This might be not accurate! |
Contents
Function
Synopsis
decompressedData = love.data.decompress( container, compressedData )
Arguments
ContainerType container- What type to return the decompressed data as.
CompressedData compressedData- The compressed data to decompress.
Returns
ByteData or string decompressedData- ByteData/string containing the raw decompressed data.
Function
Synopsis
decompressedData = love.data.decompress( container, format, compressedString )
Arguments
ContainerType container- What type to return the decompressed data as.
CompressedDataFormat format- The format that was used to compress the given string.
string compressedString- A string containing data previously compressed with love.data.compress.
Returns
ByteData or string decompressedData- ByteData/string containing the raw decompressed data.
Function
Synopsis
decompressedData = love.data.decompress( container, format, data )
Arguments
ContainerType container- What type to return the decompressed data as.
CompressedDataFormat format- The format that was used to compress the given data.
Data data- A Data object containing data previously compressed with love.data.compress.
Returns
ByteData or string decompressedData- ByteData/string containing the raw decompressed data.
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
