D3D9::IndexArray< _index_data_t, _index_caps >::LockedArea Class Reference

Locked area of index array used to access the indices. More...

#include <dx9_wrap.h>

Collaboration diagram for D3D9::IndexArray< _index_data_t, _index_caps >::LockedArea:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 LockedArea (_IndexArray &n_ia, int base_index, int count)
 Create index array locked region.

 ~LockedArea ()
 Unlock index array locked region.

_index_data_t * get_ptr ()
 Return typed pointer to start of locked memory region.

_index_data_t * get_ptr (int index_num)
 Return pointer directly to given element (from start of the locked area).

_index_data_t & operator[] (int index_num)
 operator[] returns reference to element given by it's array index from start of the area.


Detailed Description

template<typename _index_data_t, D3DFORMAT _index_caps>
class D3D9::IndexArray< _index_data_t, _index_caps >::LockedArea

Locked area of index array used to access the indices.


Constructor & Destructor Documentation

template<typename _index_data_t, D3DFORMAT _index_caps>
D3D9::IndexArray< _index_data_t, _index_caps >::LockedArea::LockedArea _IndexArray n_ia,
int  base_index,
int  count
[inline]
 

Create index array locked region.

template<typename _index_data_t, D3DFORMAT _index_caps>
D3D9::IndexArray< _index_data_t, _index_caps >::LockedArea::~LockedArea  )  [inline]
 

Unlock index array locked region.


Member Function Documentation

template<typename _index_data_t, D3DFORMAT _index_caps>
_index_data_t* D3D9::IndexArray< _index_data_t, _index_caps >::LockedArea::get_ptr  )  [inline]
 

Return typed pointer to start of locked memory region.

template<typename _index_data_t, D3DFORMAT _index_caps>
_index_data_t* D3D9::IndexArray< _index_data_t, _index_caps >::LockedArea::get_ptr int  index_num  )  [inline]
 

Return pointer directly to given element (from start of the locked area).

template<typename _index_data_t, D3DFORMAT _index_caps>
_index_data_t& D3D9::IndexArray< _index_data_t, _index_caps >::LockedArea::operator[] int  index_num  )  [inline]
 

operator[] returns reference to element given by it's array 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:25 2005 for RealityStrike Game Engine API by doxygen 1.3.6