Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Objects
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Art Samples
Tutorials

Unigine::Compress Class

Header: #include <UnigineCompress.h>

Compress class is used to compress and decompress data using Zlib or LZ4 algorithms.

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.
Last update: 2021-04-29
Build: ()