CMuli3DVertexFormat Class Reference

#include <m3dcore_vertexformat.h>

Inheritance diagram for CMuli3DVertexFormat:

List of all members.

Detailed Description

A vertex format describes the data-layout of vertex streams.

Public Member Functions

CMuli3DDevice * pGetDevice ()

Protected Member Functions

CMuli3DVertexFormat (class CMuli3DDevice *i_pParent)

result Create (const m3dvertexelement *i_pVertexDeclaration, uint32 i_iVertexDeclSize)

uint32 iGetHighestStream ()

uint32 iGetNumVertexElements ()

m3dvertexelement * pGetElements ()

~CMuli3DVertexFormat ()

Constructor & Destructor Documentation

CMuli3DVertexFormat::~CMuli3DVertexFormat ( ) [protected]

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

CMuli3DVertexFormat::CMuli3DVertexFormat ( class CMuli3DDevice * i_pParent ) [protected]

Accessible by CMuli3DDevice which is the only class that may create a vertex format.
Parameters:

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

Member Function Documentation

result CMuli3DVertexFormat::Create ( const m3dvertexelement * i_pVertexDeclaration,

uint32 i_iVertexDeclSize

) [protected]

Accessible by CMuli3DDevice which is the only class that may create a vertex format.
Parameters:

[in] i_pVertexDeclaration pointer to the vertex format declaration.

[in] i_iVertexDeclSize length of the vertex format declaration in bytes.

Returns:
s_ok if the function succeeds.
e_invalidparameters if one or more parameters were invalid.
e_outofmemory if memory allocation failed.

uint32 CMuli3DVertexFormat::iGetHighestStream ( ) [protected]

Accessible by CMuli3DDevice. Returns the highest index of the used vertex streams.

uint32 CMuli3DVertexFormat::iGetNumVertexElements ( ) [protected]

Accessible by CMuli3DDevice. Returns the number of vertex elements described in this vertex format.

CMuli3DDevice * CMuli3DVertexFormat::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.

m3dvertexelement * CMuli3DVertexFormat::pGetElements ( ) [protected]

Accessible by CMuli3DDevice. Returns a pointer to the vertex elements description.