Information about one compressor. More...
#include <compressor.h>
Inheritance diagram for EqCompressorInfo:
Public Attributes | |
| unsigned | version |
| The compressor API version used. | |
| unsigned | name |
| The type name of the compressor. | |
| unsigned | tokenType |
| The input token type supported by the compressor. | |
| eq_uint64_t | capabilities |
| Capabilities supported by the compressor. | |
| float | quality |
| Compression quality (1.0f: loss-less, <1.0f: lossy). | |
| float | ratio |
| Approximate compression ratio (sizeCompressed/sizeIn). | |
| float | speed |
| Approximate compression speed relative to BYTE_RLE. | |
| unsigned | outputTokenType |
| The output token type of a transfer plugin. | |
| unsigned | outputTokenSize |
| The size of one output token in bytes. | |
Detailed Description
Information about one compressor.
Definition at line 281 of file plugins/compressor.h.
Member Data Documentation
| eq_uint64_t EqCompressorInfo::capabilities |
Capabilities supported by the compressor.
- Version:
- 1
Definition at line 307 of file plugins/compressor.h.
Referenced by eq::util::GPUCompressor::findTransferers(), eq::base::Plugin::init(), eq::base::Plugin::initChildren(), and eq::util::GPUCompressor::initUploader().
| unsigned EqCompressorInfo::name |
The type name of the compressor.
- Version:
- 1
Definition at line 294 of file plugins/compressor.h.
Referenced by eq::util::GPUCompressor::findTransferers(), eq::base::Plugin::init(), eq::base::Plugin::initChildren(), eq::util::GPUCompressor::initDownloader(), and eq::util::GPUCompressor::initUploader().
| unsigned EqCompressorInfo::outputTokenSize |
The size of one output token in bytes.
- Version:
- 3
Definition at line 333 of file plugins/compressor.h.
Referenced by eq::base::Plugin::init().
| unsigned EqCompressorInfo::outputTokenType |
The output token type of a transfer 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 330 of file plugins/compressor.h.
Referenced by eq::util::GPUCompressor::findTransferers(), eq::base::Plugin::init(), eq::base::Plugin::initChildren(), and eq::util::GPUCompressor::initUploader().
Compression quality (1.0f: loss-less, <1.0f: lossy).
- Version:
- 1
Definition at line 310 of file plugins/compressor.h.
Referenced by eq::base::Compressor::_findPlugin(), and eq::util::GPUCompressor::findTransferers().
| float EqCompressorInfo::ratio |
Approximate compression ratio (sizeCompressed/sizeIn).
- Version:
- 1
Definition at line 313 of file plugins/compressor.h.
Referenced by eq::util::GPUCompressor::initDownloader().
| float EqCompressorInfo::speed |
Approximate compression speed relative to BYTE_RLE.
- Version:
- 1
Definition at line 316 of file plugins/compressor.h.
Referenced by eq::util::GPUCompressor::initDownloader(), and eq::util::GPUCompressor::initUploader().
| 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 304 of file plugins/compressor.h.
Referenced by eq::util::GPUCompressor::findTransferers(), eq::base::Plugin::init(), eq::base::Plugin::initChildren(), and eq::util::GPUCompressor::initUploader().
| 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 291 of file plugins/compressor.h.
Referenced by eq::base::Plugin::init().
The documentation for this struct was generated from the following file:
