liblzg  1.0.8
 All Data Structures Files Functions Variables Typedefs Macros
Data Fields
lzg_encoder_config_t Struct Reference

LZG compression configuration parameters. More...

#include <lzg.h>

Data Fields

lzg_int32_t level
 Compression level (1-9). More...
lzg_bool_t fast
 Use fast method (LZG_FALSE or LZG_TRUE). More...
 Encoding progress callback function. More...
void * userdata
 User data pointer for the progress callback function. More...

Detailed Description

LZG compression configuration parameters.

This structure is used for passing configuration options to the LZG_Encode() function. Initialize this structure to default values with LZG_InitEncoderConfig().

Field Documentation

lzg_bool_t lzg_encoder_config_t::fast

Use fast method (LZG_FALSE or LZG_TRUE).

Boolean flag that specifies whether or not to use a faster encoding acceleration data structure, which requires more memory. When using the fast method, the compression ratio is usually slightly improved.

Default value: LZG_TRUE

lzg_int32_t lzg_encoder_config_t::level

Compression level (1-9).

For convenience, you can use the predefined constants LZG_LEVEL_1 (fast) to LZG_LEVEL_9 (slow), or LZG_LEVEL_DEFAULT.

Default value: LZG_LEVEL_DEFAULT

LZGPROGRESSFUN lzg_encoder_config_t::progressfun

Encoding progress callback function.

This function will be called during compression to report progress back to the caller (set this to NULL to disable progress callback).

Default value: NULL

void* lzg_encoder_config_t::userdata

User data pointer for the progress callback function.

A user defined data pointer that can point to anything that the progress callback function may need, such as an object reference (this can set to NULL if the callback function does not need it).

Default value: NULL

The documentation for this struct was generated from the following file: