List of all members.
Public Types |
enum | Function {
NEVER = GL_NEVER,
LESS = GL_LESS,
EQUAL = GL_EQUAL,
LEQUAL = GL_LEQUAL,
GREATER = GL_GREATER,
NOTEQUAL = GL_NOTEQUAL,
GEQUAL = GL_GEQUAL,
ALWAYS = GL_ALWAYS
} |
enum | Operation {
KEEP = GL_KEEP,
ZERO = GL_ZERO,
REPLACE = GL_REPLACE,
INCR = GL_INCR,
DECR = GL_DECR,
INVERT = GL_INVERT,
INCR_WRAP = GL_INCR_WRAP,
DECR_WRAP = GL_DECR_WRAP
} |
Public Member Functions |
| Stencil () |
| Stencil (const Stencil &stencil, const CopyOp ©op=CopyOp::SHALLOW_COPY) |
| META_StateAttribute (osg, Stencil, STENCIL) |
virtual int | compare (const StateAttribute &sa) const |
virtual bool | getModeUsage (StateAttribute::ModeUsage &usage) const |
void | setFunction (Function func, int ref, unsigned int mask) |
void | setFunction (Function func) |
Function | getFunction () const |
void | setFunctionRef (int ref) |
int | getFunctionRef () const |
void | setFunctionMask (unsigned int mask) |
unsigned int | getFunctionMask () const |
void | setOperation (Operation sfail, Operation zfail, Operation zpass) |
void | setStencilFailOperation (Operation sfail) |
Operation | getStencilFailOperation () const |
void | setStencilPassAndDepthFailOperation (Operation zfail) |
Operation | getStencilPassAndDepthFailOperation () const |
void | setStencilPassAndDepthPassOperation (Operation zpass) |
Operation | getStencilPassAndDepthPassOperation () const |
void | setWriteMask (unsigned int mask) |
unsigned int | getWriteMask () const |
virtual void | apply (State &state) const |
Protected Member Functions |
virtual | ~Stencil () |
Protected Attributes |
Function | _func |
int | _funcRef |
unsigned int | _funcMask |
Operation | _sfail |
Operation | _zfail |
Operation | _zpass |
unsigned int | _writeMask |
Detailed Description
Encapsulate OpenGL glStencilFunc/Op/Mask functions.
Member Enumeration Documentation
- Enumerator:
NEVER |
|
LESS |
|
EQUAL |
|
LEQUAL |
|
GREATER |
|
NOTEQUAL |
|
GEQUAL |
|
ALWAYS |
|
- Enumerator:
KEEP |
|
ZERO |
|
REPLACE |
|
INCR |
|
DECR |
|
INVERT |
|
INCR_WRAP |
|
DECR_WRAP |
|
Constructor & Destructor Documentation
osg::Stencil::Stencil |
( |
) |
|
osg::Stencil::Stencil |
( |
const Stencil & |
stencil, |
|
|
const CopyOp & |
copyop = CopyOp::SHALLOW_COPY |
|
) |
| [inline] |
Copy constructor using CopyOp to manage deep vs shallow copy.
virtual osg::Stencil::~Stencil |
( |
) |
[protected, virtual] |
Member Function Documentation
virtual void osg::Stencil::apply |
( |
State & |
) |
const [virtual] |
apply the OpenGL state attributes. The render info for the current OpenGL context is passed in to allow the StateAttribute to obtain details on the the current context and state.
Reimplemented from osg::StateAttribute.
virtual int osg::Stencil::compare |
( |
const StateAttribute & |
sa ) |
const [inline, virtual] |
Function osg::Stencil::getFunction |
( |
) |
const [inline] |
unsigned int osg::Stencil::getFunctionMask |
( |
) |
const [inline] |
int osg::Stencil::getFunctionRef |
( |
) |
const [inline] |
Operation osg::Stencil::getStencilFailOperation |
( |
) |
const [inline] |
get the operation when the stencil test fails.
Operation osg::Stencil::getStencilPassAndDepthFailOperation |
( |
) |
const [inline] |
get the operation when the stencil test passes but the depth test fails.
Operation osg::Stencil::getStencilPassAndDepthPassOperation |
( |
) |
const [inline] |
get the operation when both the stencil test and the depth test pass.
unsigned int osg::Stencil::getWriteMask |
( |
) |
const [inline] |
osg::Stencil::META_StateAttribute |
( |
osg |
, |
|
|
Stencil |
, |
|
|
STENCIL |
|
|
) |
| |
void osg::Stencil::setFunction |
( |
Function |
func, |
|
|
int |
ref, |
|
|
unsigned int |
mask |
|
) |
| [inline] |
void osg::Stencil::setFunction |
( |
Function |
func ) |
[inline] |
void osg::Stencil::setFunctionMask |
( |
unsigned int |
mask ) |
[inline] |
void osg::Stencil::setFunctionRef |
( |
int |
ref ) |
[inline] |
set the operations to apply when the various stencil and depth tests fail or pass. First parameter is to control the operation when the stencil test fails. The second parameter is to control the operation when the stencil test passes, but depth test fails. The third parameter controls the operation when both the stencil test and depth pass. Ordering of parameter is the same as if using glStencilOp(,,).
void osg::Stencil::setStencilFailOperation |
( |
Operation |
sfail ) |
[inline] |
set the operation when the stencil test fails.
void osg::Stencil::setStencilPassAndDepthFailOperation |
( |
Operation |
zfail ) |
[inline] |
set the operation when the stencil test passes but the depth test fails.
void osg::Stencil::setStencilPassAndDepthPassOperation |
( |
Operation |
zpass ) |
[inline] |
set the operation when both the stencil test and the depth test pass.
void osg::Stencil::setWriteMask |
( |
unsigned int |
mask ) |
[inline] |
Member Data Documentation
The documentation for this class was generated from the following file: