csRenderBufferLock< T > Class Template Reference
Helper class for convenient locking/unlocking of an iRenderBuffer. More...
#include <cstool/rbuflock.h>
Public Member Functions | |
csRenderBufferLock (iRenderBuffer *buf, csRenderBufferLockType lock=CS_BUF_LOCK_NORMAL) | |
Construct the helper. | |
T & | Get (size_t n) |
Retrieve an item in the render buffer. | |
size_t | GetSize () const |
Retrieve number of items in buffer. | |
T * | Lock () |
Lock the renderbuffer. | |
operator T * () | |
Retrieve a pointer to the contained data. | |
T & | operator[] (size_t n) |
Retrieve an item in the render buffer. | |
void | Unlock () |
Unlock the renderbuffer. | |
~csRenderBufferLock () | |
Destruct the helper. |
Detailed Description
template<class T>
class csRenderBufferLock< T >
Helper class for convenient locking/unlocking of an iRenderBuffer.
The contents can be accessed either directly or array-style in typed way.
Definition at line 36 of file rbuflock.h.
Constructor & Destructor Documentation
|
Construct the helper.
Definition at line 49 of file rbuflock.h. |
|
Destruct the helper. Automatically unlocks the buffer if it was locked. Definition at line 59 of file rbuflock.h. References csRenderBufferLock< T >::Unlock(). |
Member Function Documentation
|
Retrieve an item in the render buffer.
Definition at line 104 of file rbuflock.h. References csRenderBufferLock< T >::Lock(). Referenced by csRenderBufferLock< T >::operator[](). |
|
Retrieve number of items in buffer.
Definition at line 110 of file rbuflock.h. |
|
Lock the renderbuffer. Returns a pointer to the contained data.
Definition at line 68 of file rbuflock.h. Referenced by csRenderBufferLock< T >::Get(), and csRenderBufferLock< T >::operator T *(). |
|
Retrieve a pointer to the contained data.
Definition at line 92 of file rbuflock.h. References csRenderBufferLock< T >::Lock(). |
|
Retrieve an item in the render buffer.
Definition at line 98 of file rbuflock.h. References csRenderBufferLock< T >::Get(). |
|
Unlock the renderbuffer.
Definition at line 79 of file rbuflock.h. Referenced by csRenderBufferLock< T >::~csRenderBufferLock(). |
The documentation for this class was generated from the following file:
- cstool/rbuflock.h
Generated for Crystal Space by doxygen 1.4.4