openscenegraph
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Stencil Class Reference
Inheritance diagram for osg::Stencil:
osg::StateAttribute osg::Object osg::Referenced

Classes

class  Extensions
 

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 Types inherited from osg::StateAttribute
enum  Values {
  OFF = 0x0, ON = 0x1, OVERRIDE = 0x2, PROTECTED = 0x4,
  INHERIT = 0x8
}
 
enum  Type {
  TEXTURE, POLYGONMODE, POLYGONOFFSET, MATERIAL,
  ALPHAFUNC, ANTIALIAS, COLORTABLE, CULLFACE,
  FOG, FRONTFACE, LIGHT, POINT,
  LINEWIDTH, LINESTIPPLE, POLYGONSTIPPLE, SHADEMODEL,
  TEXENV, TEXENVFILTER, TEXGEN, TEXMAT,
  LIGHTMODEL, BLENDFUNC, BLENDEQUATION, LOGICOP,
  STENCIL, COLORMASK, DEPTH, VIEWPORT,
  SCISSOR, BLENDCOLOR, MULTISAMPLE, CLIPPLANE,
  COLORMATRIX, VERTEXPROGRAM, FRAGMENTPROGRAM, POINTSPRITE,
  PROGRAM, CLAMPCOLOR, HINT, SAMPLEMASKI,
  PRIMITIVERESTARTINDEX, VALIDATOR, VIEWMATRIXEXTRACTOR, OSGNV_PARAMETER_BLOCK,
  OSGNVEXT_TEXTURE_SHADER, OSGNVEXT_VERTEX_PROGRAM, OSGNVEXT_REGISTER_COMBINERS, OSGNVCG_PROGRAM,
  OSGNVSLANG_PROGRAM, OSGNVPARSE_PROGRAM_PARSER, UNIFORMBUFFERBINDING, TRANSFORMFEEDBACKBUFFERBINDING,
  ATOMICCOUNTERBUFFERBINDING, PATCH_PARAMETER
}
 
typedef GLenum GLMode
 
typedef unsigned int GLModeValue
 
typedef unsigned int OverrideValue
 
typedef std::pair< Type,
unsigned int > 		TypeMemberPair
 
typedef std::vector< StateSet * > ParentList
 
typedef osg::StateAttributeCallback Callback
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 Stencil ()
 
 Stencil (const Stencil &stencil, const CopyOp &copyop=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
 
- Public Member Functions inherited from osg::StateAttribute
 StateAttribute ()
 
 StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual Object * cloneType () const =0
 
virtual Object * clone (const CopyOp &) const =0
 
virtual bool isSameKindAs (const Object *obj) const
 
virtual const char * libraryName () const
 
virtual const char * className () const
 
virtual Texture * asTexture ()
 
virtual const Texture * asTexture () const
 
virtual Type getType () const =0
 
virtual unsigned int getMember () const
 
TypeMemberPair getTypeMemberPair () const
 
virtual bool isTextureAttribute () const
 
bool operator< (const StateAttribute &rhs) const
 
bool operator== (const StateAttribute &rhs) const
 
bool operator!= (const StateAttribute &rhs) const
 
const ParentList & getParents () const
 
StateSet * getParent (unsigned int i)
 
const StateSet * getParent (unsigned int i) const
 
unsigned int getNumParents () const
 
void setShaderComponent (ShaderComponent *sc)
 
ShaderComponent * getShaderComponent ()
 
const ShaderComponent * getShaderComponent () const
 
virtual bool checkValidityOfAssociatedModes (osg::State &) const
 
void setUpdateCallback (StateAttributeCallback *uc)
 
StateAttributeCallback * getUpdateCallback ()
 
const StateAttributeCallback * getUpdateCallback () const
 
void setEventCallback (StateAttributeCallback *ec)
 
StateAttributeCallback * getEventCallback ()
 
const StateAttributeCallback * getEventCallback () const
 
virtual void compileGLObjects (State &) const
 
virtual void resizeGLObjectBuffers (unsigned int)
 
virtual void releaseGLObjects (State *=0) const
 
- Public Member Functions inherited from osg::Object
 Object ()
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 
virtual void setName (const std::string &name)
 
void setName (const char *name)
 
const std::string & getName () const
 
void setDataVariance (DataVariance dv)
 
DataVariance getDataVariance () const
 
virtual void computeDataVariance ()
 
void setUserDataContainer (osg::UserDataContainer *udc)
 
osg::UserDataContainer * getUserDataContainer ()
 
const osg::UserDataContainer * getUserDataContainer () const
 
osg::UserDataContainer * getOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
virtual Referenced * getUserData ()
 
virtual const Referenced * getUserData () const
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 
template<typename T >
BoolValueObject
UCharValueObject
UShortValueObject
UIntValueObject
DoubleValueObject
Vec3fValueObject
Vec2dValueObject
Vec4dValueObject
PlaneValueObject
MatrixdValueObject bool 		getUserValue (const std::string &name, T &value) const
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referenced & operator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 
OpenThreads::Mutex * getRefMutex () const
 
int ref () const
 
int unref () const
 
int unref_nodelete () const
 
int referenceCount () const
 
ObserverSet * getObserverSet () const
 
ObserverSet * getOrCreateObserverSet () const
 
void addObserver (Observer *observer) const
 
void removeObserver (Observer *observer) const
 

Static Public Member Functions

static Extensions * getExtensions (unsigned int contextID, bool createIfNotInitalized)
 
static void setExtensions (unsigned int contextID, Extensions *extensions)
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
static void setDeleteHandler (DeleteHandler *handler)
 
static DeleteHandler * getDeleteHandler ()
 

Protected Member Functions

virtual ~Stencil ()
 
- Protected Member Functions inherited from osg::StateAttribute
virtual ~StateAttribute ()
 
void addParent (osg::StateSet *object)
 
void removeParent (osg::StateSet *object)
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

Function _func
 
int _funcRef
 
unsigned int _funcMask
 
Operation _sfail
 
Operation _zfail
 
Operation _zpass
 
unsigned int _writeMask
 
- Protected Attributes inherited from osg::StateAttribute
ParentList _parents
 
ref_ptr< ShaderComponent > _shaderComponent
 
ref_ptr< StateAttributeCallback > _updateCallback
 
ref_ptr< StateAttributeCallback > _eventCallback
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer * _userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Detailed Description

Encapsulate OpenGL glStencilFunc/Op/Mask functions.

All functionality except INCR_WRAP and DECR_WRAP is supported by OpenGL 1.1. INCR_WRAP an DECR_WRAP are available since OpenGL 1.4 or when GL_EXT_stencil_wrap extension is present.

If INCR_WRAP or DECR_WRAP values are used while they are detected to be not supported, the INCR or DECR values are sent to OpenGL instead. Note: do not use Stencil::getFunction() to detect whether WRAP operations is used as the object's value is kept intact. Use osg::Stencil::getExtensions() method instead.

OpenGL 2.0 introduced two side stenciling that is available through osg::StencilTwoSided class.

Member Enumeration Documentation

enum osg::Stencil::Function
Enumerator
NEVER 
LESS 
EQUAL 
LEQUAL 
GREATER 
NOTEQUAL 
GEQUAL 
ALWAYS 
enum osg::Stencil::Operation
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 ( )
protectedvirtual

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
inlinevirtual

return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

Implements osg::StateAttribute.

References COMPARE_StateAttribute_Parameter, and COMPARE_StateAttribute_Types.

static Extensions* osg::Stencil::getExtensions ( unsigned int  contextID,
bool  createIfNotInitalized 
)
static

Function to call to get the extension of a specified context. If the Extension object for that context has not yet been created and the 'createIfNotInitalized' flag been set to false then returns NULL. If 'createIfNotInitalized' is true then the Extensions object is automatically created. However, in this case the extension object will only be created with the graphics context associated with ContextID.

Function osg::Stencil::getFunction ( ) const
inline
unsigned int osg::Stencil::getFunctionMask ( ) const
inline
int osg::Stencil::getFunctionRef ( ) const
inline
virtual bool osg::Stencil::getModeUsage ( StateAttribute::ModeUsage &  ) const
inlinevirtual

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

References osg::StateAttribute::ModeUsage::usesMode().

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   
)
static void osg::Stencil::setExtensions ( unsigned int  contextID,
Extensions *  extensions 
)
static

The setExtensions method allows users to override the extensions across graphics contexts. Typically used when you have different extensions supported across graphics pipes but need to ensure that they all use the same low common denominator extensions.

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
void osg::Stencil::setOperation ( Operation  sfail,
Operation  zfail,
Operation  zpass 
)
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

Function osg::Stencil::_func
protected
unsigned int osg::Stencil::_funcMask
protected
int osg::Stencil::_funcRef
protected
Operation osg::Stencil::_sfail
protected
unsigned int osg::Stencil::_writeMask
protected
Operation osg::Stencil::_zfail
protected
Operation osg::Stencil::_zpass
protected
The documentation for this class was generated from the following file:
Generated on Tue Sep 30 2014 19:50:15 for openscenegraph by   doxygen 1.8.6