OpenSceneGraph
3.2.0
|
Encapsulate OpenGL glStencilFunc/Op/Mask functions. More...
Classes | |
class | Extensions |
Extensions class which encapsulates the querying of extensions and associated function pointers, and provide convenience wrappers to check for the extensions or use the associated functions. More... | |
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 } |
![]() | |
enum | Values { OFF = 0x0, ON = 0x1, OVERRIDE = 0x2, PROTECTED = 0x4, INHERIT = 0x8 } |
list values which can be used to set either GLModeValues or OverrideValues. More... | |
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, FRAME_BUFFER_OBJECT } |
Type identifier to differentiate between different state types. More... | |
typedef GLenum | GLMode |
GLMode is the value used in glEnable/glDisable(mode) More... | |
typedef unsigned int | GLModeValue |
GLModeValue is used to specify whether a mode is enabled (ON) or disabled (OFF). More... | |
typedef unsigned int | OverrideValue |
Override is used to specify the override behavior of StateAttributes from parent to children. More... | |
typedef std::pair< Type, unsigned int > | TypeMemberPair |
Simple pairing between an attribute type and the member within that attribute type group. More... | |
typedef std::vector< StateSet * > | ParentList |
A vector of osg::StateSet pointers which is used to store the parent(s) of this StateAttribute. More... | |
typedef osg::StateAttributeCallback | Callback |
![]() | |
enum | DataVariance { DYNAMIC, STATIC, UNSPECIFIED } |
Public Member Functions | |
Stencil () | |
Stencil (const Stencil &stencil, const CopyOp ©op=CopyOp::SHALLOW_COPY) | |
Copy constructor using CopyOp to manage deep vs shallow copy. More... | |
META_StateAttribute (osg, Stencil, STENCIL) | |
virtual int | compare (const StateAttribute &sa) const |
return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. More... | |
virtual bool | getModeUsage (StateAttribute::ModeUsage &usage) const |
Return the modes associated with this StateAttribute. More... | |
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) |
set the operations to apply when the various stencil and depth tests fail or pass. More... | |
void | setStencilFailOperation (Operation sfail) |
set the operation when the stencil test fails. More... | |
Operation | getStencilFailOperation () const |
get the operation when the stencil test fails. More... | |
void | setStencilPassAndDepthFailOperation (Operation zfail) |
set the operation when the stencil test passes but the depth test fails. More... | |
Operation | getStencilPassAndDepthFailOperation () const |
get the operation when the stencil test passes but the depth test fails. More... | |
void | setStencilPassAndDepthPassOperation (Operation zpass) |
set the operation when both the stencil test and the depth test pass. More... | |
Operation | getStencilPassAndDepthPassOperation () const |
get the operation when both the stencil test and the depth test pass. More... | |
void | setWriteMask (unsigned int mask) |
unsigned int | getWriteMask () const |
virtual void | apply (State &state) const |
apply the OpenGL state attributes. More... | |
![]() | |
StateAttribute () | |
StateAttribute (const StateAttribute &sa, const CopyOp ©op=CopyOp::SHALLOW_COPY) | |
virtual Object * | cloneType () const =0 |
Clone the type of an attribute, with Object* return type. More... | |
virtual Object * | clone (const CopyOp &) const =0 |
Clone an attribute, with Object* return type. More... | |
virtual bool | isSameKindAs (const Object *obj) const |
Return true if this and obj are of the same kind of object. More... | |
virtual const char * | libraryName () const |
Return the name of the attribute's library. More... | |
virtual const char * | className () const |
Return the name of the attribute's class type. More... | |
virtual Texture * | asTexture () |
Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More... | |
virtual const Texture * | asTexture () const |
Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More... | |
virtual Type | getType () const =0 |
Return the Type identifier of the attribute's class type. More... | |
virtual unsigned int | getMember () const |
Return the member identifier within the attribute's class type. More... | |
TypeMemberPair | getTypeMemberPair () const |
Return the TypeMemberPair that uniquely identifies this type member. More... | |
virtual bool | isTextureAttribute () const |
Return true if StateAttribute is a type which controls texturing and needs to be issued w.r.t to specific texture unit. More... | |
bool | operator< (const StateAttribute &rhs) const |
bool | operator== (const StateAttribute &rhs) const |
bool | operator!= (const StateAttribute &rhs) const |
const ParentList & | getParents () const |
Get the parent list of this StateAttribute. More... | |
StateSet * | getParent (unsigned int i) |
const StateSet * | getParent (unsigned int i) const |
Get a single const parent of this StateAttribute. More... | |
unsigned int | getNumParents () const |
Get the number of parents of this StateAttribute. More... | |
void | setShaderComponent (ShaderComponent *sc) |
ShaderComponent * | getShaderComponent () |
const ShaderComponent * | getShaderComponent () const |
virtual bool | checkValidityOfAssociatedModes (osg::State &) const |
Check the modes associated with this StateAttribute are supported by current OpenGL drivers, and if not set the associated mode in osg::State to be black listed/invalid. More... | |
void | setUpdateCallback (StateAttributeCallback *uc) |
Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal. More... | |
StateAttributeCallback * | getUpdateCallback () |
Get the non const UpdateCallback. More... | |
const StateAttributeCallback * | getUpdateCallback () const |
Get the const UpdateCallback. More... | |
void | setEventCallback (StateAttributeCallback *ec) |
Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal. More... | |
StateAttributeCallback * | getEventCallback () |
Get the non const EventCallback. More... | |
const StateAttributeCallback * | getEventCallback () const |
Get the const EventCallback. More... | |
virtual void | compileGLObjects (State &) const |
Default to nothing to compile - all state is applied immediately. More... | |
virtual void | resizeGLObjectBuffers (unsigned int) |
Resize any per context GLObject buffers to specified size. More... | |
virtual void | releaseGLObjects (State *=0) const |
Release OpenGL objects in specified graphics context if State object is passed, otherwise release OpenGL objects for all graphics context if State object pointer NULL. More... | |
![]() | |
Object () | |
Construct an object. More... | |
Object (bool threadSafeRefUnref) | |
Object (const Object &, const CopyOp ©op=CopyOp::SHALLOW_COPY) | |
Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More... | |
virtual void | setThreadSafeRefUnref (bool threadSafe) |
Set whether to use a mutex to ensure ref() and unref() are thread safe. More... | |
virtual void | setName (const std::string &name) |
Set the name of object using C++ style string. More... | |
void | setName (const char *name) |
Set the name of object using a C style string. More... | |
const std::string & | getName () const |
Get the name of object. More... | |
void | setDataVariance (DataVariance dv) |
Set the data variance of this object. More... | |
DataVariance | getDataVariance () const |
Get the data variance of this object. More... | |
virtual void | computeDataVariance () |
Compute the DataVariance based on an assessment of callback etc. More... | |
void | setUserDataContainer (osg::UserDataContainer *udc) |
set the UserDataContainer object. More... | |
osg::UserDataContainer * | getUserDataContainer () |
get the UserDataContainer attached to this object. More... | |
const osg::UserDataContainer * | getUserDataContainer () const |
get the const UserDataContainer attached to this object. More... | |
osg::UserDataContainer * | getOrCreateUserDataContainer () |
Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More... | |
virtual void | setUserData (Referenced *obj) |
Set user data, data must be subclassed from Referenced to allow automatic memory handling. More... | |
virtual Referenced * | getUserData () |
Get user data. More... | |
virtual const Referenced * | getUserData () const |
Get const user data. More... | |
template<typename T > | |
bool | getUserValue (const std::string &name, T &value) const |
Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More... | |
template<typename T > | |
void | setUserValue (const std::string &name, const T &value) |
Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More... | |
template<typename T > | |
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject bool | getUserValue (const std::string &name, T &value) const |
provide implementation of osg::Object::getUserValue(..) template More... | |
![]() | |
Referenced () | |
Referenced (bool threadSafeRefUnref) | |
Referenced (const Referenced &) | |
Referenced & | operator= (const Referenced &) |
bool | getThreadSafeRefUnref () const |
Get whether a mutex is used to ensure ref() and unref() are thread safe. More... | |
OpenThreads::Mutex * | getRefMutex () const |
Get the mutex used to ensure thread safety of ref()/unref(). More... | |
int | ref () const |
Increment the reference count by one, indicating that this object has another pointer which is referencing it. More... | |
int | unref () const |
Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More... | |
int | unref_nodelete () const |
Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More... | |
int | referenceCount () const |
Return the number of pointers currently referencing this object. More... | |
ObserverSet * | getObserverSet () const |
Get the ObserverSet if one is attached, otherwise return NULL. More... | |
ObserverSet * | getOrCreateObserverSet () const |
Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More... | |
void | addObserver (Observer *observer) const |
Add a Observer that is observing this object, notify the Observer when this object gets deleted. More... | |
void | removeObserver (Observer *observer) const |
Remove Observer that is observing this object. More... | |
Static Public Member Functions | |
static Extensions * | getExtensions (unsigned int contextID, bool createIfNotInitalized) |
Function to call to get the extension of a specified context. More... | |
static void | setExtensions (unsigned int contextID, Extensions *extensions) |
The setExtensions method allows users to override the extensions across graphics contexts. More... | |
Protected Member Functions | |
virtual | ~Stencil () |
![]() | |
virtual | ~StateAttribute () |
void | addParent (osg::StateSet *object) |
void | removeParent (osg::StateSet *object) |
![]() | |
virtual | ~Object () |
Object destructor. More... | |
![]() | |
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 |
![]() | |
ParentList | _parents |
ref_ptr< ShaderComponent > | _shaderComponent |
ref_ptr< StateAttributeCallback > | _updateCallback |
ref_ptr< StateAttributeCallback > | _eventCallback |
![]() | |
std::string | _name |
DataVariance | _dataVariance |
osg::UserDataContainer * | _userDataContainer |
![]() | |
OpenThreads::AtomicPtr | _observerSet |
OpenThreads::Atomic | _refCount |
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.
osg::Stencil::Stencil | ( | ) |
|
inline |
Copy constructor using CopyOp to manage deep vs shallow copy.
|
protectedvirtual |
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.
|
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 |
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.
|
inline |
|
inline |
|
inline |
|
inlinevirtual |
Return the modes associated with this StateAttribute.
Reimplemented from osg::StateAttribute.
References osg::StateAttribute::ModeUsage::usesMode().
|
inline |
get the operation when the stencil test fails.
|
inline |
get the operation when the stencil test passes but the depth test fails.
|
inline |
get the operation when both the stencil test and the depth test pass.
|
inline |
|
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.
|
inline |
|
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(,,).
set the operation when the stencil test fails.
set the operation when the stencil test passes but the depth test fails.
set the operation when both the stencil test and the depth test pass.
|
inline |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
![]() | Generated at Thu Aug 15 2013 02:32:09 for the OpenSceneGraph by doxygen 1.8.4. |