ClanLib  2.3.7
List of all members
CL_VertexArrayBuffer Class Reference

Vertex Array Buffer. More...

#include <vertex_array_buffer.h>

Public Member Functions

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

Detailed Description

Vertex Array Buffer.

Constructor & Destructor Documentation

CL_VertexArrayBuffer::CL_VertexArrayBuffer ( )

Constructs a null instance.

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

Constructs a VertexArrayBuffer.

Parameters
gc= Graphic Context
size= value
usage= Buffer Usage
CL_VertexArrayBuffer::CL_VertexArrayBuffer ( CL_GraphicContext gc,
void *  data,
int  size,
CL_BufferUsage  usage = cl_usage_static_draw 
)

Constructs a VertexArrayBuffer.

Parameters
gc= Graphic Context
data= void
size= value
usage= Buffer Usage
virtual CL_VertexArrayBuffer::~CL_VertexArrayBuffer ( )
virtual

Member Function Documentation

void* CL_VertexArrayBuffer::get_data ( )

Retrieves a pointer to the mapped buffer.

CL_VertexArrayBufferProvider* CL_VertexArrayBuffer::get_provider ( ) const

Get Provider.

Returns
provider
bool CL_VertexArrayBuffer::is_null ( ) const
inline

Returns true if this object is invalid.

void CL_VertexArrayBuffer::lock ( CL_BufferAccess  access)

Maps vertex buffer into system memory.

bool CL_VertexArrayBuffer::operator== ( const CL_VertexArrayBuffer other) const

Handle comparison operator.

void CL_VertexArrayBuffer::throw_if_null ( ) const

Throw an exception if this object is invalid.

void CL_VertexArrayBuffer::unlock ( )

Unmaps vertex buffer.

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

Uploads data to vertex array buffer.


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