Main Page -
Class Hierarchy -
Class List -
File List -
Class Members -
Related Pages -

Information | Reference | SourceForge Project | Author
Muli3D

Reference: Muli3D: CMuli3DVertexBuffer Class Reference

CMuli3DVertexBuffer Class Reference

#include <m3dcore_vertexbuffer.h>

Inheritance diagram for CMuli3DVertexBuffer:

IBase List of all members.

Detailed Description

Vertex buffers are memory buffers that contain vertex-data, which is described by a vertex format.


Public Member Functions

result GetPointer (uint32 i_iOffset, void **o_ppData)
uint32 iGetLength ()
CMuli3DDevicepGetDevice ()

Protected Member Functions

 CMuli3DVertexBuffer (class CMuli3DDevice *i_pParent)
result Create (uint32 i_iLength)
 ~CMuli3DVertexBuffer ()


Constructor & Destructor Documentation

CMuli3DVertexBuffer::~CMuli3DVertexBuffer  )  [protected]
 

Accessible by IBase. The destructor is called when the reference count reaches zero.

CMuli3DVertexBuffer::CMuli3DVertexBuffer class CMuli3DDevice i_pParent  )  [protected]
 

Accessible by CMuli3DDevice which is the only class that may create a vertex buffer.

Parameters:
[in] i_pParent a pointer to the parent CMuli3DDevice-object.


Member Function Documentation

result CMuli3DVertexBuffer::Create uint32  i_iLength  )  [protected]
 

Accessible by CMuli3DDevice which is the only class that may create a vertex buffer.

Parameters:
[in] i_iLength length of the vertex buffer to be created in bytes.
Returns:
s_ok if the function succeeds.

e_invalidparameters if one or more parameters were invalid.

e_outofmemory if memory allocation failed.

result CMuli3DVertexBuffer::GetPointer uint32  i_iOffset,
void **  o_ppData
 

Returns a pointer to the desired position in the buffer.

Parameters:
[in] i_iOffset has to be specified in bytes.
[out] o_ppData receives the pointer to the vertex buffer.
Returns:
s_ok if the function succeeds.

e_invalidparameters if one or more parameters were invalid.

uint32 CMuli3DVertexBuffer::iGetLength  ) 
 

Returns the length of the buffer in bytes.

CMuli3DDevice * CMuli3DVertexBuffer::pGetDevice  ) 
 

Returns a pointer to the associated device. Calling this function will increase the internal reference count of the device. Failure to call Release() when finished using the pointer will result in a memory leak.

Documentation created with doxygen SourceForge.net Logo