lunchbox::Uploader Class Reference

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

#include <uploader.h>

Inheritance diagram for lunchbox::Uploader:

Collaboration diagram for lunchbox::Uploader:

Public Member Functions
LUNCHBOX_API	Uploader ()
	Construct a new, invalid uploader instance. More...
LUNCHBOX_API	Uploader (PluginRegistry &from, const uint32_t name)
	Construct a new, named uploader instance. More...
virtual LUNCHBOX_API	~Uploader ()
	Destruct this uploader. More...
LUNCHBOX_API bool	isGood (const GLEWContext *gl) const
LUNCHBOX_API bool	uses (const uint32_t name) const
LUNCHBOX_API bool	supports (const uint32_t externalFormat, const uint32_t internalFormat, const uint64_t capabilities, const GLEWContext *gl) const
LUNCHBOX_API const EqCompressorInfo &	getInfo () const
LUNCHBOX_API bool	setup (PluginRegistry &from, const uint32_t name)
	Set up a new, named uploader instance. More...
LUNCHBOX_API bool	setup (PluginRegistry &from, const uint32_t externalFormat, const uint32_t internalFormat, const uint64_t capabilities, const GLEWContext *gl)
	Set up a new, auto-selected uploader instance. More...
LUNCHBOX_API void	clear ()
	Reset to EQ_COMPRESSOR_NONE. More...
LUNCHBOX_API void	upload (const void *buffer, const uint64_t inDims[4], const uint64_t flags, const uint64_t outDims[4], const unsigned destination, const GLEWContext *gl)
	Upload data from cpu to the frame buffer or texture. More...

Static Public Member Functions
static LUNCHBOX_API uint32_t	choose (const PluginRegistry &from, const uint32_t externalFormat, const uint32_t internalFormat, const uint64_t capabilities, const GLEWContext *gl)
	Find the best uploader in all plugins for the given parameters. More...

Detailed Description

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

Definition at line 32 of file uploader.h.

Constructor & Destructor Documentation

LUNCHBOX_API lunchbox::Uploader::Uploader

(

)

Construct a new, invalid uploader instance.

Version

1.7.1

LUNCHBOX_API lunchbox::Uploader::Uploader	(	PluginRegistry &	from,
		const uint32_t	name
	)

Construct a new, named uploader instance.

Parameters

from	the plugin registry.
name	the name of the uploader.

Version

1.7.1

virtual LUNCHBOX_API lunchbox::Uploader::~Uploader ( )

virtual

Destruct this uploader.

Version

1.7.1

Member Function Documentation

static LUNCHBOX_API uint32_t lunchbox::Uploader::choose ( const PluginRegistry &  from, const uint32_t  externalFormat, const uint32_t  internalFormat, const uint64_t  capabilities, const GLEWContext *  gl  )

static

Find the best uploader in all plugins for the given parameters.

This convenience method searches all compressors in all plugins to find the uploader which supports the given parameters and provides the highest speed.

Version

1.7.1

LUNCHBOX_API void lunchbox::Uploader::clear

(

)

Reset to EQ_COMPRESSOR_NONE.

Version

1.7.1

LUNCHBOX_API const EqCompressorInfo& lunchbox::Uploader::getInfo

(

)

const

Returns

the information about the allocated uploader.

Version

1.7.1

LUNCHBOX_API bool lunchbox::Uploader::isGood

(

const GLEWContext *

gl

)

const

Returns

true if the instance is usable.

Version

1.7.1

LUNCHBOX_API bool lunchbox::Uploader::setup	(	PluginRegistry &	from,
		const uint32_t	name
	)

Set up a new, named uploader instance.

Parameters

from	the plugin registry
name	the name of the uploader

Returns

true on success, false otherwise.

Version

1.7.1

LUNCHBOX_API bool lunchbox::Uploader::setup	(	PluginRegistry &	from,
		const uint32_t	externalFormat,
		const uint32_t	internalFormat,
		const uint64_t	capabilities,
		const GLEWContext *	gl
	)

Set up a new, auto-selected uploader instance.

See Also

choose() for parameters.

Version

1.7.1

LUNCHBOX_API bool lunchbox::Uploader::supports	(	const uint32_t	externalFormat,
		const uint32_t	internalFormat,
		const uint64_t	capabilities,
		const GLEWContext *	gl
	)		const

Returns

true if the uploader supports the given parameters.

Version

1.7.1

LUNCHBOX_API void lunchbox::Uploader::upload	(	const void *	buffer,
		const uint64_t	inDims[4],
		const uint64_t	flags,
		const uint64_t	outDims[4],
		const unsigned	destination,
		const GLEWContext *	gl
	)

Upload data from cpu to the frame buffer or texture.

Parameters

buffer	data source
inDims	the dimensions of the input data
flags	capability flags for the compression
outDims	the dimensions of the output data
destination	the destination texture name, or 0 for framebuffer
gl	the OpenGL function table

Version

1.7.1

LUNCHBOX_API bool lunchbox::Uploader::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:

• uploader.h