v0.4.1
Fast, portable C library for geometry input/output
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Modules
Data Fields
gmio_zlib_compress_options Struct Reference

zlib compression options More...

Data Fields

uint8_t level
 Compression level. More...
 
enum gmio_zlib_compress_strategy strategy
 Compression strategy. More...
 
uint8_t memory_usage
 Specifies how much memory should be allocated for the internal compression state. More...
 
void *(* func_alloc )(void *opaque, unsigned int items, unsigned int size)
 Optional function used to allocate the internal state within z_stream. More...
 
void(* func_free )(void *opaque, void *address)
 Optional function used to free the internal state within z_stream. More...
 
void * opaque
 Optional private data object passed to func_alloc() and func_free() More...
 

Detailed Description

zlib compression options

Initialising gmio_zlib_compress_options with {0} (or {} in C++) is the convenient way to set default values.

Field Documentation

uint8_t gmio_zlib_compress_options::level

Compression level.

Use enum value from gmio_zlib_compress_level

enum gmio_zlib_compress_strategy gmio_zlib_compress_options::strategy

Compression strategy.

uint8_t gmio_zlib_compress_options::memory_usage

Specifies how much memory should be allocated for the internal compression state.

The value must belongs to [1..9] or equals to 0 which maps to the default usage.

1 uses minimum memory but is slow and reduces compression ratio
9 uses maximum memory for optimal speed

void*(* gmio_zlib_compress_options::func_alloc)(void *opaque, unsigned int items, unsigned int size)

Optional function used to allocate the internal state within z_stream.

See also
z_stream::zalloc
void(* gmio_zlib_compress_options::func_free)(void *opaque, void *address)

Optional function used to free the internal state within z_stream.

See also
z_stream::zfree
void* gmio_zlib_compress_options::opaque

Optional private data object passed to func_alloc() and func_free()

See also
z_stream::opaque

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