Difference between revisions of "Zlib.compress"
From GiderosMobile
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2015.04.18<br/> | '''Available since:''' Gideros 2015.04.18<br/> | ||
| + | '''Class:''' [[zlib]]<br/> | ||
| + | |||
=== Description === | === Description === | ||
| − | + | Returns a string containing the compressed buffer according to the given parameters. | |
| − | < | + | <syntaxhighlight lang="lua"> |
(string) = zlib.compress(buffer,level,method,windowBits,memLevel,strategy) | (string) = zlib.compress(buffer,level,method,windowBits,memLevel,strategy) | ||
| − | </ | + | </syntaxhighlight> |
| + | |||
=== Parameters === | === Parameters === | ||
| − | '''buffer''': (string) | + | '''buffer''': (string) string to compress<br/> |
| − | '''level''': (number) | + | '''level''': (number) compression level, 0 no compression, 9 best compression, -1 default compression '''optional'''<br/> |
| − | '''method''': (number) | + | '''method''': (number) compression method, should be 8 for this version '''optional'''<br/> |
| − | '''windowBits''': (number) | + | '''windowBits''': (number) from 8 to 15, larger values of this parameter result in better compression at the expense of memory usage '''optional'''<br/> |
| − | '''memLevel''': (number) | + | '''memLevel''': (number) 1 uses minimum memory but is slow and reduces compression ratio; 9 uses maximum memory for optimal speed '''optional'''<br/> |
| − | '''strategy''': (number) | + | '''strategy''': (number) 1 - Filtered, 2 - Huffman, 3 - RLE, 4 - Fixed, 0 - default '''optional'''<br/> |
| + | |||
=== Return values === | === Return values === | ||
| − | '''Returns''' (string) | + | '''Returns''' (string) compressed string<br/> |
| + | |||
| + | {{Zlib}} | ||
Latest revision as of 22:33, 1 December 2023
Available since: Gideros 2015.04.18
Class: zlib
Description
Returns a string containing the compressed buffer according to the given parameters.
(string) = zlib.compress(buffer,level,method,windowBits,memLevel,strategy)
Parameters
buffer: (string) string to compress
level: (number) compression level, 0 no compression, 9 best compression, -1 default compression optional
method: (number) compression method, should be 8 for this version optional
windowBits: (number) from 8 to 15, larger values of this parameter result in better compression at the expense of memory usage optional
memLevel: (number) 1 uses minimum memory but is slow and reduces compression ratio; 9 uses maximum memory for optimal speed optional
strategy: (number) 1 - Filtered, 2 - Huffman, 3 - RLE, 4 - Fixed, 0 - default optional
Return values
Returns (string) compressed string
