CL_ElementArrayBuffer Class Reference [clanDisplay Display]

Element Array Buffer. More...

#include <element_array_buffer.h>

List of all members.

Public Member Functions
Construction
	CL_ElementArrayBuffer ()
	Constructs a null instance.
	CL_ElementArrayBuffer (CL_GraphicContext &gc, int size, CL_BufferUsage usage=cl_usage_static_draw)
	Constructs a ElementArrayBuffer.
	CL_ElementArrayBuffer (CL_GraphicContext &gc, void *data, int size, CL_BufferUsage usage=cl_usage_static_draw)
	Constructs a ElementArrayBuffer.
virtual	~CL_ElementArrayBuffer ()
Attributes
bool	is_null () const
	Returns true if this object is invalid.
void	throw_if_null () const
	Throw an exception if this object is invalid.
void *	get_data ()
	Retrieves a pointer to the mapped buffer.
CL_ElementArrayBufferProvider *	get_provider () const
	Get Provider.
Operations
bool	operator== (const CL_ElementArrayBuffer &other) const
	Handle comparison operator.
void	lock (CL_BufferAccess access)
	Maps element buffer into system memory.
void	unlock ()
	Unmaps element buffer.
void	upload_data (int offset, void *data, int size)
	Uploads data to element array buffer.

---

Detailed Description

Element Array Buffer.

---

Constructor & Destructor Documentation

CL_ElementArrayBuffer::CL_ElementArrayBuffer

(

)

Constructs a null instance.

CL_ElementArrayBuffer::CL_ElementArrayBuffer	(	CL_GraphicContext &	gc,
		int	size,
		CL_BufferUsage	usage = cl_usage_static_draw
	)

Constructs a ElementArrayBuffer.

Parameters:

	gc	= Graphic Context
	size	= value
	usage	= Buffer Usage

CL_ElementArrayBuffer::CL_ElementArrayBuffer	(	CL_GraphicContext &	gc,
		void *	data,
		int	size,
		CL_BufferUsage	usage = cl_usage_static_draw
	)

Constructs a ElementArrayBuffer.

Parameters:

	gc	= Graphic Context
	data	= void
	size	= value
	usage	= Buffer Usage

virtual CL_ElementArrayBuffer::~CL_ElementArrayBuffer

(

)

[virtual]

---

Member Function Documentation

void* CL_ElementArrayBuffer::get_data

(

)

Retrieves a pointer to the mapped buffer.

CL_ElementArrayBufferProvider* CL_ElementArrayBuffer::get_provider

(

)

const

Get Provider.

Returns:

provider

bool CL_ElementArrayBuffer::is_null

(

)

const [inline]

Returns true if this object is invalid.

void CL_ElementArrayBuffer::lock

(

CL_BufferAccess

access

)

Maps element buffer into system memory.

bool CL_ElementArrayBuffer::operator==

(

const CL_ElementArrayBuffer &

other

)

const

Handle comparison operator.

void CL_ElementArrayBuffer::throw_if_null

(

)

const

Throw an exception if this object is invalid.

void CL_ElementArrayBuffer::unlock

(

)

Unmaps element buffer.

void CL_ElementArrayBuffer::upload_data	(	int	offset,
		void *	data,
		int	size
	)

Uploads data to element array buffer.

---

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

• element_array_buffer.h