Lunchbox  1.8.0
Public Member Functions | List of all members
lunchbox::Decompressor Class Reference

A C++ class to handle one decompressor plugin instance. More...

#include <decompressor.h>

+ Inheritance diagram for lunchbox::Decompressor:
+ Collaboration diagram for lunchbox::Decompressor:

Public Member Functions

 Decompressor ()
 Construct a new, invalid decompressor instance.
 Decompressor (PluginRegistry &from, const uint32_t name)
 Construct a new decompressor instance.
virtual ~Decompressor ()
 Destruct this decompressor.
bool isGood () const
bool uses (const uint32_t name) const
const EqCompressorInfogetInfo () const
bool setup (PluginRegistry &from, const uint32_t name)
 Set up a new, named decompressor instance.
void clear ()
 Reset to EQ_COMPRESSOR_NONE.
void decompress (const void *const *in, const uint64_t *const inSizes, const unsigned numInputs, void *const out, uint64_t outDim[2])
 Decompress one-dimensional data.
void decompress (const void *const *in, const uint64_t *const inSizes, const unsigned numInputs, void *const out, uint64_t pvpOut[4], const uint64_t flags)
 Decompress two-dimensional data.

Detailed Description

A C++ class to handle one decompressor plugin instance.

Definition at line 32 of file decompressor.h.

Constructor & Destructor Documentation

lunchbox::Decompressor::Decompressor ( )

Construct a new, invalid decompressor instance.

Version
1.7.1
lunchbox::Decompressor::Decompressor ( PluginRegistry from,
const uint32_t  name 
)

Construct a new decompressor instance.

Parameters
fromthe plugin registry.
namethe name of the decompressor.
Version
1.7.1
virtual lunchbox::Decompressor::~Decompressor ( )
virtual

Destruct this decompressor.

Version
1.7.1

Member Function Documentation

void lunchbox::Decompressor::clear ( )

Reset to EQ_COMPRESSOR_NONE.

Version
1.7.1
void lunchbox::Decompressor::decompress ( const void *const *  in,
const uint64_t *const  inSizes,
const unsigned  numInputs,
void *const  out,
uint64_t  outDim[2] 
)

Decompress one-dimensional data.

Parameters
inthe pointer to an array of input data pointers
inSizesthe array of input data sizes in bytes
numInputsthe number of input data elements
outthe pointer to a pre-allocated buffer for the uncompressed output result.
outDimthe dimensions of the output data.
Version
1.7.1
void lunchbox::Decompressor::decompress ( const void *const *  in,
const uint64_t *const  inSizes,
const unsigned  numInputs,
void *const  out,
uint64_t  pvpOut[4],
const uint64_t  flags 
)

Decompress two-dimensional data.

Parameters
inthe pointer to an array of input data pointers
inSizesthe array of input data sizes in bytes
numInputsthe number of input data elements
outthe pointer to a pre-allocated buffer for the uncompressed output result.
pvpOutthe dimensions of the output data.
flagscapability flags for the decompression.
Version
1.7.1
const EqCompressorInfo& lunchbox::Decompressor::getInfo ( ) const
Returns
the information about the allocated instance.
Version
1.7.1
bool lunchbox::Decompressor::isGood ( ) const
Returns
true if the instance is usable.
Version
1.7.1
bool lunchbox::Decompressor::setup ( PluginRegistry from,
const uint32_t  name 
)

Set up a new, named decompressor instance.

Parameters
fromthe plugin registry.
namethe name of the decompressor.
Returns
true on success, false otherwise.
Version
1.7.1
bool lunchbox::Decompressor::uses ( const uint32_t  name) const
Returns
true if the instance is usable for the given name.
Version
1.7.1

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