EqCompressorInfo Struct Reference

Information about one compressor. More...

#include <compressor.h>

Collaboration diagram for EqCompressorInfo:

Public Attributes
unsigned	version
	The compressor API version used. More...
unsigned	name
	The type name of the compressor. More...
unsigned	tokenType
	The input token type supported by the compressor. More...
eq_uint64_t	capabilities
	Capabilities supported by the compressor. More...
float	quality
	Compression quality (1.0f: loss-less, <1.0f: lossy). More...
float	ratio
	Approximate compression ratio (sizeCompressed/sizeIn). More...
float	speed
	Approximate compression speed relative to BYTE_RLE. More...
unsigned	outputTokenType
	The output token type of a plugin. More...
unsigned	outputTokenSize
	The size of one output token in bytes. More...

Detailed Description

Information about one compressor.

Definition at line 318 of file plugins/compressor.h.

Member Data Documentation

eq_uint64_t EqCompressorInfo::capabilities

Capabilities supported by the compressor.

Version

1

Definition at line 344 of file plugins/compressor.h.

unsigned EqCompressorInfo::name

The type name of the compressor.

Version

1

Definition at line 331 of file plugins/compressor.h.

unsigned EqCompressorInfo::outputTokenSize

The size of one output token in bytes.

Version

3

Definition at line 370 of file plugins/compressor.h.

unsigned EqCompressorInfo::outputTokenType

The output token type of a plugin.

The output token type describes the format of the data produced by a downloader and consumed by the uploader of the same compressor.

A CPU compressor might set the output token type if its decompressor produces an output different from the input.

If this parameter is set, outputTokenSize has to be set as well.

Version

3

Definition at line 367 of file plugins/compressor.h.

float EqCompressorInfo::quality

Compression quality (1.0f: loss-less, <1.0f: lossy).

Version

1

Definition at line 347 of file plugins/compressor.h.

float EqCompressorInfo::ratio

Approximate compression ratio (sizeCompressed/sizeIn).

Version

1

Definition at line 350 of file plugins/compressor.h.

float EqCompressorInfo::speed

Approximate compression speed relative to BYTE_RLE.

Version

1

Definition at line 353 of file plugins/compressor.h.

unsigned EqCompressorInfo::tokenType

The input token type supported by the compressor.

The input token type describes the format of the input data for a compressor or downloader and the format of the output data for the decompressor or uploader of the same compressor.

Version

1

Definition at line 341 of file plugins/compressor.h.

unsigned EqCompressorInfo::version

The compressor API version used.

Set on input to the API version used in Equalizer. Has to be set to EQ_COMPRESSOR_VERSION on output to declare the API version used to compile the DSO.

Version

1

Definition at line 328 of file plugins/compressor.h.

---

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

• plugins/compressor.h