Zlib.compress: Difference between revisions

From GiderosMobile
Created page with "__NOTOC__ '''Available since:''' Gideros 2015.04.18<br/> === Description === Return a string containing the compressed buffer according to the given parameters. <source lang="..."
 
No edit summary
Line 4: Line 4:
Return a string containing the compressed buffer according to the given parameters.
Return a string containing the compressed buffer according to the given parameters.
<source lang="lua">
<source lang="lua">
(string), = zlib.compress(bufferlevelmethodwindowBitsmemLevelstrategy,)
(string) = zlib.compress(buffer,level,method,windowBits,memLevel,strategy)
</source>
</source>
'''buffer:''' (string) string to compress ''''''<br/>
'''buffer''': (string) string to compress ''''''<br/>
'''level:''' (number) compression level, 0 no compression, 9 best compression, -1 default compression '''optional'''<br/>
'''level''': (number) compression level, 0 no compression, 9 best compression, -1 default compression '''optional'''<br/>
'''method:''' (number) compression method, should be 8 for this version '''optional'''<br/>
'''method''': (number) compression method, should be 8 for this version '''optional'''<br/>
'''windowBits:''' (number) from 8 to 15, larger values of this parameter result in better compression at the expense of memory usage '''optional'''<br/>
'''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) 1 uses minimum memory but is slow and reduces compression ratio; 9 uses maximum memory for optimal speed '''optional'''<br/>
'''memLevel''': (number) 1 uses minimum memory but is slow and reduces compression ratio; 9 uses maximum memory for optimal speed '''optional'''<br/>
'''strategy:''' (number) 1 - Filtered, 2 - Huffman, 3 - RLE, 4 - Fixed, 0 - default '''optional'''<br/>
'''strategy''': (number) 1 - Filtered, 2 - Huffman, 3 - RLE, 4 - Fixed, 0 - default '''optional'''<br/>
'''Returns''' (string) compressed string<br/>
'''Returns''' (string) compressed string<br/>

Revision as of 09:20, 23 August 2018

Available since: Gideros 2015.04.18

Description

Return a string containing the compressed buffer according to the given parameters.

(string) = zlib.compress(buffer,level,method,windowBits,memLevel,strategy)

'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
Returns (string) compressed string