VRS::StencilBitGL Class Reference
Managing bit-planes in the OpenGL stencil-buffer. More...
#include <vrs/opengl/stencilbitgl.h>
Public Types | |
| enum | StencilType { Free = -2, All = -1, Mirror = 1, Halo = 2 } |
Public Member Functions | |
| VRS_SERIALIZABLE_CLASS_ENUM (StencilType) | |
| StencilBitGL (StencilType effect) | |
| virtual | ~StencilBitGL () |
| Frees the reserved bit. | |
| int | getBit () const |
| Returns the reserved bit. | |
| VRS_TYPEINFO (StencilBitGL, SharedObj) | |
Static Public Member Functions | |
| static int | getMask (StencilType effect) |
| static void | init () |
| static void | clearStencilBits (int clearMask) |
Detailed Description
Managing bit-planes in the OpenGL stencil-buffer.Member Enumeration Documentation
Constructor & Destructor Documentation
| VRS::StencilBitGL::StencilBitGL | ( | StencilType | effect | ) |
The class StencilBitGL is meant to be used internally only by techniques or high-level attribute painters. The constructor reserves a bit in a stencil-buffer that can be used exclusively by the caller (provided nobody else manipulates the stencil- buffer directly, of course). The constructor is not meant to be called with "Free" or "All"; if, no bit is reserved.
| virtual VRS::StencilBitGL::~StencilBitGL | ( | ) | [virtual] |
Frees the reserved bit.
Member Function Documentation
| VRS::StencilBitGL::VRS_SERIALIZABLE_CLASS_ENUM | ( | StencilType | ) |
| int VRS::StencilBitGL::getBit | ( | ) | const [inline] |
Returns the reserved bit.
| static int VRS::StencilBitGL::getMask | ( | StencilType | effect | ) | [static] |
Returns all bits that are reserved by a specific type. Free: Returns all bits that not used otherwise. All: Returns all bits, be they used or free.
| static void VRS::StencilBitGL::init | ( | ) | [static] |
Checks the number of bit-planes in the stencil-buffer. Does not free any reserved bits, but emits a warning (in Debug-Mode) if it is called when not all bits are free.
| static void VRS::StencilBitGL::clearStencilBits | ( | int | clearMask | ) | [static] |
Clears the stencil-buffer bit-planes indicated by mask to zero.
| VRS::StencilBitGL::VRS_TYPEINFO | ( | StencilBitGL | , | |
| SharedObj | ||||
| ) |
The documentation for this class was generated from the following file: