Equalizer  1.4.1
Public Member Functions | Public Attributes | Public Types
co::Plugin Class Reference
+ Inheritance diagram for co::Plugin:
+ Collaboration diagram for co::Plugin:

List of all members.

Public Member Functions

bool init (const std::string &libraryName)
 Init and link a compressor plugin.
void exit ()
 Unload a compressor plugin.
void initChildren ()
 Initialize the child list for each compressor.
bool implementsType (const uint32_t name) const
const CompressorInfos & getInfos () const
const CompressorInfofindInfo (const uint32_t name) const

Public Attributes

GetNumCompressors_t getNumCompressors
 Get the number of engines found in the plugin.
NewCompressor_t newCompressor
 Get a new compressor instance.
NewDecompressor_t newDecompressor
 Get a new decompressor instance.
DeleteCompressor_t deleteCompressor
 Delete the compressor instance.
DeleteDecompressor_t deleteDecompressor
 Delete the decompressor instance.
Compress_t compress
 Compress data.
Decompress_t decompress
 Decompress data.
GetNumResults_t getNumResults
 Get the number of results from the last compression.
GetResult_t getResult
 Get the nth result from the last compression.
IsCompatible_t isCompatible
 Check if the transfer plugin can be used.
Download_t download
 Download pixel data.
Upload_t upload
 Upload pixel data.
StartDownload_t startDownload
 Start downloading pixel data.
FinishDownload_t finishDownload
 Start downloading pixel data.

Public Types

typedef size_t(* GetNumCompressors_t )()
typedef void(* GetInfo_t )(const size_t, EqCompressorInfo *const )
typedef void *(* NewCompressor_t )(const unsigned)
typedef void(* DeleteCompressor_t )(void *const )
typedef void *(* NewDecompressor_t )(const unsigned)
typedef void(* DeleteDecompressor_t )(void *const )
typedef void(* Compress_t )(void *const, const unsigned, void *const, const uint64_t *, const uint64_t)
typedef unsigned(* GetNumResults_t )(void *const, const unsigned)
typedef void(* GetResult_t )(void *const, const unsigned, const unsigned, void **const, uint64_t *const )
typedef void(* Decompress_t )(void *const, const unsigned, const void *const *, const uint64_t *const, const unsigned, void *const, uint64_t *const, const uint64_t)
typedef bool(* IsCompatible_t )(const unsigned, const GLEWContext *)
typedef void(* Download_t )(void *const, const unsigned, const GLEWContext *, const uint64_t *, const unsigned, const uint64_t, uint64_t *, void **)
typedef void(* StartDownload_t )(void *const, const unsigned, const GLEWContext *, const uint64_t *, const unsigned, const uint64_t)
typedef void(* FinishDownload_t )(void *const, const unsigned, const GLEWContext *, const uint64_t *, const uint64_t, uint64_t *, void **)
typedef void(* Upload_t )(void *const, const unsigned, const GLEWContext *, const void *, const uint64_t *, const uint64_t, const uint64_t *, const unsigned)

Detailed Description

Definition at line 32 of file plugin.h.


Member Function Documentation

void co::Plugin::exit ( )

Unload a compressor plugin.

const CompressorInfo& co::Plugin::findInfo ( const uint32_t  name) const
Returns:
the information for the given compressor, or 0.
const CompressorInfos& co::Plugin::getInfos ( ) const [inline]
Returns:
the information for all compressors contained in the DSO.

Definition at line 128 of file plugin.h.

bool co::Plugin::implementsType ( const uint32_t  name) const
Returns:
true if name is found in the plugin.
bool co::Plugin::init ( const std::string &  libraryName)

Init and link a compressor plugin.

Initialize the child list for each compressor.


Member Data Documentation

Compress data.

Definition at line 98 of file plugin.h.

Decompress_t co::Plugin::decompress

Decompress data.

Definition at line 101 of file plugin.h.

DeleteCompressor_t co::Plugin::deleteCompressor

Delete the compressor instance.

Definition at line 92 of file plugin.h.

DeleteDecompressor_t co::Plugin::deleteDecompressor

Delete the decompressor instance.

Definition at line 95 of file plugin.h.

Download pixel data.

Definition at line 113 of file plugin.h.

FinishDownload_t co::Plugin::finishDownload

Start downloading pixel data.

Definition at line 122 of file plugin.h.

GetNumCompressors_t co::Plugin::getNumCompressors

Get the number of engines found in the plugin.

Definition at line 83 of file plugin.h.

GetNumResults_t co::Plugin::getNumResults

Get the number of results from the last compression.

Definition at line 104 of file plugin.h.

GetResult_t co::Plugin::getResult

Get the nth result from the last compression.

Definition at line 107 of file plugin.h.

IsCompatible_t co::Plugin::isCompatible

Check if the transfer plugin can be used.

Definition at line 110 of file plugin.h.

NewCompressor_t co::Plugin::newCompressor

Get a new compressor instance.

Definition at line 86 of file plugin.h.

NewDecompressor_t co::Plugin::newDecompressor

Get a new decompressor instance.

Definition at line 89 of file plugin.h.

StartDownload_t co::Plugin::startDownload

Start downloading pixel data.

Definition at line 119 of file plugin.h.

Upload pixel data.

Definition at line 116 of file plugin.h.


The documentation for this class was generated from the following file:
Generated on Mon Nov 26 2012 14:41:50 for Equalizer 1.4.1 by  doxygen 1.7.6.1