GFXVertexBufferHandle< T > Class Template Reference

#include <gfxVertexBuffer.h>

Inheritance diagram for GFXVertexBufferHandle< T >:

Inheritance graph
[legend]
List of all members.


template<class T> class GFXVertexBufferHandle< T >


Public Member Functions

 GFXVertexBufferHandle ()
 GFXVertexBufferHandle (GFXDevice *theDevice, U32 numVerts=0, GFXBufferType bufferType=GFXBufferTypeVolatile)
void set (GFXDevice *theDevice, U32 numVerts=0, GFXBufferType t=GFXBufferTypeVolatile)
T * lock (U32 vertexStart=0, U32 vertexEnd=0)
void unlock ()
T & operator[] (U32 index)
const T & operator[] (U32 index) const
 < Array operator allows indexing into a locked vertex buffer.
T & operator[] (S32 index)
const T & operator[] (S32 index) const
 < Array operator allows indexing into a locked vertex buffer.
GFXVertexBufferHandle< T > & operator= (GFXVertexBuffer *ptr)

Private Member Functions

void prepare ()

Constructor & Destructor Documentation

template<class T>
GFXVertexBufferHandle< T >::GFXVertexBufferHandle (  )  [inline]

template<class T>
GFXVertexBufferHandle< T >::GFXVertexBufferHandle ( GFXDevice theDevice,
U32  numVerts = 0,
GFXBufferType  bufferType = GFXBufferTypeVolatile 
) [inline]


Member Function Documentation

template<class T>
void GFXVertexBufferHandle< T >::prepare (  )  [inline, private]

template<class T>
void GFXVertexBufferHandle< T >::set ( GFXDevice theDevice,
U32  numVerts = 0,
GFXBufferType  t = GFXBufferTypeVolatile 
) [inline]

template<class T>
T* GFXVertexBufferHandle< T >::lock ( U32  vertexStart = 0,
U32  vertexEnd = 0 
) [inline]

Parameters:
vertexEnd  locks the vertex buffer range, and returns a pointer to the beginning of the vertex array also allows the array operators to work on this vertex buffer.

Reimplemented from GFXVertexBufferHandleBase.

template<class T>
void GFXVertexBufferHandle< T >::unlock (  )  [inline]

Reimplemented from GFXVertexBufferHandleBase.

template<class T>
T& GFXVertexBufferHandle< T >::operator[] ( U32  index  )  [inline]

Parameters:
index  Array operator allows indexing into a locked vertex buffer. The debug version of the code will range check the array access as well as validate the locked vertex buffer pointer.

template<class T>
const T& GFXVertexBufferHandle< T >::operator[] ( U32  index  )  const [inline]

< Array operator allows indexing into a locked vertex buffer.

The debug version of the code will range check the array access as well as validate the locked vertex buffer pointer.

template<class T>
T& GFXVertexBufferHandle< T >::operator[] ( S32  index  )  [inline]

Parameters:
index  Array operator allows indexing into a locked vertex buffer. The debug version of the code will range check the array access as well as validate the locked vertex buffer pointer.

template<class T>
const T& GFXVertexBufferHandle< T >::operator[] ( S32  index  )  const [inline]

< Array operator allows indexing into a locked vertex buffer.

The debug version of the code will range check the array access as well as validate the locked vertex buffer pointer.

template<class T>
GFXVertexBufferHandle<T>& GFXVertexBufferHandle< T >::operator= ( GFXVertexBuffer ptr  )  [inline]

Reimplemented from StrongRefPtr< GFXVertexBuffer >.