D3D9::VertexArray< _vertex_data_t, _vertex_caps >::LockedArea Class Reference

Locked area of vertex array used to access the vertices. More...

#include <dx9_wrap.h>

Collaboration diagram for D3D9::VertexArray< _vertex_data_t, _vertex_caps >::LockedArea:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 LockedArea (_VertexArray &n_va, int base_vertex, int count)
 Create vertex array locked region.

 ~LockedArea ()
 Unlock vertex array locked region.

_vertex_data_t * get_ptr ()
 Return typed pointer to start of locked vertex array memory region.

_vertex_data_t * get_ptr (int vertex_num)
 Return pointer directly to given vertex (given by index from start of the area).

_vertex_data_t & operator[] (int vertex_num)
 operator[] returns reference to element given by index from start of the area.


Detailed Description

template<typename _vertex_data_t, DWORD _vertex_caps = 0>
class D3D9::VertexArray< _vertex_data_t, _vertex_caps >::LockedArea

Locked area of vertex array used to access the vertices.


Constructor & Destructor Documentation

template<typename _vertex_data_t, DWORD _vertex_caps = 0>
D3D9::VertexArray< _vertex_data_t, _vertex_caps >::LockedArea::LockedArea _VertexArray n_va,
int  base_vertex,
int  count
[inline]
 

Create vertex array locked region.

template<typename _vertex_data_t, DWORD _vertex_caps = 0>
D3D9::VertexArray< _vertex_data_t, _vertex_caps >::LockedArea::~LockedArea  )  [inline]
 

Unlock vertex array locked region.


Member Function Documentation

template<typename _vertex_data_t, DWORD _vertex_caps = 0>
_vertex_data_t* D3D9::VertexArray< _vertex_data_t, _vertex_caps >::LockedArea::get_ptr  )  [inline]
 

Return typed pointer to start of locked vertex array memory region.

template<typename _vertex_data_t, DWORD _vertex_caps = 0>
_vertex_data_t* D3D9::VertexArray< _vertex_data_t, _vertex_caps >::LockedArea::get_ptr int  vertex_num  )  [inline]
 

Return pointer directly to given vertex (given by index from start of the area).

template<typename _vertex_data_t, DWORD _vertex_caps = 0>
_vertex_data_t& D3D9::VertexArray< _vertex_data_t, _vertex_caps >::LockedArea::operator[] int  vertex_num  )  [inline]
 

operator[] returns reference to element given by index from start of the area.

Note:
This handy feature gives strongly typed LockeAreas abilty to look and feel like native C++ array.


The documentation for this class was generated from the following file:
Generated on Sun May 1 17:34:24 2005 for RealityStrike Game Engine API by doxygen 1.3.6