BufferBase Class Reference

Buffer base class. More...

#include <Buffer.h>

Inheritance diagram for BufferBase:

List of all members.

Classes
class	FrequencyMode
	Frequency mode. More...
class	NatureMode
	Nature mode. More...
class	SignalID
	Signal identifier enum. More...
Public Types
typedef std::shared_ptr < BufferBase >	Ptr
	Shared pointer.
Public Member Functions
virtual const std::string &	getClassName () const
	Get name of this class.
bool	clear ()
	Clear data.
unsigned int	getGlID () const
	Get OpenGL buffer identifier.
FrequencyMode	getFrequencyMode () const
	Get frequency mode.
NatureMode	getNatureMode () const
	Get nature mode.
void	setFrequencyMode (FrequencyMode frequencyMode)
	Set frequency mode.
void	setNatureMode (NatureMode natureMode)
	Set nature mode.
Protected Member Functions
bool	mapBuffer (void **mappedPtr) const
	Map buffer from graphics card memory to system memory.
bool	unmapBuffer () const
	Unmap buffer from system memory.
bool	setPlainData (const void *data, size_t size)
	Set buffer with plain data.
Protected Attributes
size_t	m_byteSize

---

Detailed Description

Buffer base class.

Buffer base stores raw OpenGL information about buffer object.

---

Member Function Documentation

bool BufferBase::clear

(

)

Clear data.

Clear all buffer data leaving buffer empty with zero size.

Returns:

True if cleared successfully.

FrequencyMode BufferBase::getFrequencyMode

(

)

const

Get frequency mode.

Returns:

Frequency mode.

unsigned int BufferBase::getGlID

(

)

const

Get OpenGL buffer identifier.

Returns:

Numeric identifier of buffer object in OpenGL.

NatureMode BufferBase::getNatureMode

(

)

const

Get nature mode.

Returns:

Nature mode.

bool BufferBase::mapBuffer

(

void **

mappedPtr

)

const [protected]

Map buffer from graphics card memory to system memory.

Parameters:

mappedPtr

Pointer to pointer to first index.

void BufferBase::setFrequencyMode

(

FrequencyMode

frequencyMode

)

Set frequency mode.

New mode will be applied after next setData() call.

Parameters:

frequencyMode

Frequency mode.

void BufferBase::setNatureMode

(

NatureMode

natureMode

)

Set nature mode.

New mode will be applied in next setData() call.

Parameters:

natureMode

Nature mode.

bool BufferBase::setPlainData	(	const void *	data,
		size_t	size
	)		[protected]

Set buffer with plain data.

Parameters:

data	Pointer to plain data.
size	Size of plain data in bytes.

Returns:

True if data were set successfully.

---

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

• D:/Visual Studio 2010/Projects/Unishader project/Unishader/include/UniShader/Buffer.h