#include <StencilTwoSided.h>

Inheritance diagram for osg::StencilTwoSided:

Collaboration diagram for osg::StencilTwoSided:

Public Types
enum	Face { FRONT = 0, BACK = 1 }

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, CLIPCONTROL, 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, VERTEX_ATTRIB_DIVISOR, SHADERSTORAGEBUFFERBINDING, CAPABILITY = 100 }

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
	StencilTwoSided ()

	StencilTwoSided (const StencilTwoSided &stencil, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

	META_StateAttribute (osg, StencilTwoSided, STENCIL)

virtual int	compare (const StateAttribute &sa) const

virtual bool	getModeUsage (StateAttribute::ModeUsage &usage) const

void	setFunction (Face face, Function func, int ref, unsigned int mask)

void	setFunction (Face face, Function func)

Function	getFunction (Face face) const

void	setFunctionRef (Face face, int ref)

int	getFunctionRef (Face face) const

void	setFunctionMask (Face face, unsigned int mask)

unsigned int	getFunctionMask (Face face) const

void	setOperation (Face face, Operation sfail, Operation zfail, Operation zpass)

void	setStencilFailOperation (Face face, Operation sfail)

Operation	getStencilFailOperation (Face face) const

void	setStencilPassAndDepthFailOperation (Face face, Operation zfail)

Operation	getStencilPassAndDepthFailOperation (Face face) const

void	setStencilPassAndDepthPassOperation (Face face, Operation zpass)

Operation	getStencilPassAndDepthPassOperation (Face face) const

void	setWriteMask (Face face, unsigned int mask)

unsigned int	getWriteMask (Face face) 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 StateAttribute *	asStateAttribute ()

virtual const StateAttribute *	asStateAttribute () 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)

std::string	getCompoundClassName () const

virtual Node *	asNode ()

virtual const Node *	asNode () const

virtual NodeVisitor *	asNodeVisitor ()

virtual const NodeVisitor *	asNodeVisitor () const

virtual Uniform *	asUniform ()

virtual const Uniform *	asUniform () const

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 BoundingBoxdValueObject BoundingSpheredValueObject 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

Protected Member Functions
virtual	~StencilTwoSided ()

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 [2]

int	_funcRef [2]

unsigned int	_funcMask [2]

Operation	_sfail [2]

Operation	_zfail [2]

Operation	_zpass [2]

unsigned int	_writeMask [2]

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

Additional Inherited Members
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 ()

Detailed Description

Provides OpenGL two sided stencil functionality, also known as separate stencil. It enables to specify different stencil function for front and back facing polygons. Two sided stenciling is used usually to eliminate the need of two rendering passes when using standard stenciling functions. See also

See also: osg::Stencil.

Two sided stenciling is available since OpenGL 2.0. It is also supported by EXT_stencil_two_side extension especially on Nvidia cards. Another extension introduced by ATI is ATI_separate_stencil. However, ATI's extension is limited to have reference and mask value the same for both faces. ATI's extension is currently not supported by the current implementation.

osg::StencilTwoSided does nothing if OpenGL 2.0 or EXT_stencil_two_side are not available.

Definition at line 38 of file StencilTwoSided.h.

Member Enumeration Documentation

enum osg::StencilTwoSided::Face

Enumerator
FRONT
BACK

Definition at line 59 of file StencilTwoSided.h.

enum osg::StencilTwoSided::Function

Enumerator
NEVER
LESS
EQUAL
LEQUAL
GREATER
NOTEQUAL
GEQUAL
ALWAYS

Definition at line 65 of file StencilTwoSided.h.

enum osg::StencilTwoSided::Operation

Enumerator
KEEP
ZERO
REPLACE
INCR
DECR
INVERT
INCR_WRAP
DECR_WRAP

Definition at line 94 of file StencilTwoSided.h.

Constructor & Destructor Documentation

osg::StencilTwoSided::StencilTwoSided ( )

osg::StencilTwoSided::StencilTwoSided	(	const StencilTwoSided &	stencil,
		const CopyOp &	copyop = `CopyOp::SHALLOW_COPY`
	)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::StencilTwoSided::~StencilTwoSided ( )

protectedvirtual

Member Function Documentation

virtual void osg::StencilTwoSided::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::StencilTwoSided::compare ( const StateAttribute & sa ) const

virtual

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

Implements osg::StateAttribute.

Function osg::StencilTwoSided::getFunction ( Face face ) const

inline

Definition at line 85 of file StencilTwoSided.h.

unsigned int osg::StencilTwoSided::getFunctionMask ( Face face ) const

inline

Definition at line 91 of file StencilTwoSided.h.

int osg::StencilTwoSided::getFunctionRef ( Face face ) const

inline

Definition at line 88 of file StencilTwoSided.h.

virtual bool osg::StencilTwoSided::getModeUsage ( StateAttribute::ModeUsage & ) const

inlinevirtual

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

Definition at line 53 of file StencilTwoSided.h.

Here is the call graph for this function:

Operation osg::StencilTwoSided::getStencilFailOperation ( Face face ) const

inline

get the operation when the stencil test fails.

Definition at line 124 of file StencilTwoSided.h.

Operation osg::StencilTwoSided::getStencilPassAndDepthFailOperation ( Face face ) const

inline

get the operation when the stencil test passes but the depth test fails.

Definition at line 130 of file StencilTwoSided.h.

Operation osg::StencilTwoSided::getStencilPassAndDepthPassOperation ( Face face ) const

inline

get the operation when both the stencil test and the depth test pass.

Definition at line 136 of file StencilTwoSided.h.

unsigned int osg::StencilTwoSided::getWriteMask ( Face face ) const

inline

Definition at line 141 of file StencilTwoSided.h.

osg::StencilTwoSided::META_StateAttribute	(	osg	,
		StencilTwoSided	,
		STENCIL
	)

void osg::StencilTwoSided::setFunction	(	Face	face,
		Function	func,
		int	ref,
		unsigned int	mask
	)

inline

Definition at line 77 of file StencilTwoSided.h.

void osg::StencilTwoSided::setFunction	(	Face	face,
		Function	func
	)

inline

Definition at line 84 of file StencilTwoSided.h.

void osg::StencilTwoSided::setFunctionMask	(	Face	face,
		unsigned int	mask
	)

inline

Definition at line 90 of file StencilTwoSided.h.

void osg::StencilTwoSided::setFunctionRef	(	Face	face,
		int	ref
	)

inline

Definition at line 87 of file StencilTwoSided.h.

void osg::StencilTwoSided::setOperation	(	Face	face,
		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(,,).

Definition at line 113 of file StencilTwoSided.h.

void osg::StencilTwoSided::setStencilFailOperation	(	Face	face,
		Operation	sfail
	)

inline

set the operation when the stencil test fails.

Definition at line 121 of file StencilTwoSided.h.

void osg::StencilTwoSided::setStencilPassAndDepthFailOperation	(	Face	face,
		Operation	zfail
	)

inline

set the operation when the stencil test passes but the depth test fails.

Definition at line 127 of file StencilTwoSided.h.

void osg::StencilTwoSided::setStencilPassAndDepthPassOperation	(	Face	face,
		Operation	zpass
	)

inline

set the operation when both the stencil test and the depth test pass.

Definition at line 133 of file StencilTwoSided.h.

void osg::StencilTwoSided::setWriteMask	(	Face	face,
		unsigned int	mask
	)

inline

Definition at line 139 of file StencilTwoSided.h.

Member Data Documentation

Function osg::StencilTwoSided::_func[2]

protected

Definition at line 150 of file StencilTwoSided.h.

unsigned int osg::StencilTwoSided::_funcMask[2]

protected

Definition at line 152 of file StencilTwoSided.h.

int osg::StencilTwoSided::_funcRef[2]

protected

Definition at line 151 of file StencilTwoSided.h.

Operation osg::StencilTwoSided::_sfail[2]

protected

Definition at line 154 of file StencilTwoSided.h.

unsigned int osg::StencilTwoSided::_writeMask[2]

protected

Definition at line 158 of file StencilTwoSided.h.

Operation osg::StencilTwoSided::_zfail[2]

protected

Definition at line 155 of file StencilTwoSided.h.

Operation osg::StencilTwoSided::_zpass[2]

protected

Definition at line 156 of file StencilTwoSided.h.

The documentation for this class was generated from the following file:

osg_head/include/osg/StencilTwoSided.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation