Unigine::Compress Class

Compress Class

Members

---

bool zlibCompress ( void * dest, size_t & dest_size, const void * src, size_t src_size, bool quality ) #

Compresses the source data using the Zlib algorithm with the specified compression level and puts the result to the specified destination.

Arguments

• void * dest - Destination buffer pointer.
• size_t & dest_size - Destination data size.
• const void * src - Source buffer pointer.
• size_t src_size - Source data size.
• bool quality - Compression quality; false is for faster compression, true is for higher compression (less size).

Return value

true if the operation was successful; otherwise, false.

bool zlibDecompress ( void * dest, size_t dest_size, const void * src, size_t src_size ) #

Decompresses the source data using the Zlib algorithm and puts the result to the specified destination.

Arguments

• void * dest - Destination buffer pointer.
• size_t dest_size - Destination data size.
• const void * src - Source buffer pointer.
• size_t src_size - Source data size.

Return value

true if the operation was successful; otherwise, false.

size_t zlibSize ( size_t size ) #

Returns the maximum Zlib-compressed data size for the specified uncompressed size value.

Arguments

• size_t size - Uncompressed data size.

Return value

Maximum Zlib-compressed data size.

size_t lz4Size ( size_t size ) #

Returns the maximum LZ4-compressed data size for the specified uncompressed size value.

Arguments

• size_t size - Uncompressed data size.

Return value

Maximum lz4-compressed data size.

bool lz4Compress ( void * dest, size_t & dest_size, const void * src, size_t src_size, bool quality ) #

Compresses the source data using the LZ4 algorithm with the specified compression level and puts the result to the specified destination.

Arguments

• void * dest - Destination buffer pointer.
• size_t & dest_size - Destination data size.
• const void * src - Source buffer pointer.
• size_t src_size - Source data size.
• bool quality - Compression quality; false is for faster compression, true is for higher compression (less size).

Return value

true if the operation was successful; otherwise, false.

bool lz4Decompress ( void * dest, size_t dest_size, const void * src, size_t src_size ) #

Decompresses the source data using the LZ4 algorithm and puts the result to the specified destination.

Arguments

• void * dest - Destination buffer pointer.
• size_t dest_size - Destination data size.
• const void * src - Source buffer pointer.
• size_t src_size - Source data size.

Return value

true if the operation was successful; otherwise, false.