SoStencilBitsElement Class Reference

#include <Inventor/elements/SoStencilBitsElement.h>

Inheritance diagram for SoStencilBitsElement:

List of all members.

Public Member Functions
virtual void	init (SoState *state)
	Initializes element.
virtual void	push (SoState *state)
	Overrides push() method to copy values from next instance in the stack.
Static Public Member Functions
static uint32_t	acquireBits (SoState *state, SoNode *node, int num)
	Acquires a certain number of bits for stencil operations.
static void	releaseBits (SoState *state, uint32_t mask)
	Releases the stencil bits specified by the mask.
static void	clearBitsInUse (SoState *state)
	Forget about the stencil bits in use.
static uint32_t	get (SoState *state)
	Returns a mask of the current stencil bits in use.
static uint32_t	getDefault ()
	Returns the default mask of stencil bits in use.
static int	getNumRemainingBits (SoState *state)
	Returns the number of stencil bits not currently used.
static void	initClass ()
	Initializes the SoStencilBitsElement class.
Protected Member Functions
virtual	~SoStencilBitsElement ()
	Destructor.
int	getNumGLBits () const
	Returns the number of bits supported by GL implementation.
Static Protected Member Functions
static int	getNumBitPositionsToShift (uint32_t mask, SoState *state)
	Number of positions a value must be shifted according to mask.

---

Detailed Description

Definition at line 54 of file SoStencilBitsElement.h.

---

Constructor & Destructor Documentation

virtual SoStencilBitsElement::~SoStencilBitsElement

(

)

[protected, virtual]

---

Member Function Documentation

static uint32_t SoStencilBitsElement::acquireBits	(	SoState *	state,
		SoNode *	node,
		int	num
	)		[static]

This returns a mask of the acquired bits or 0x0 if there are not enough stencil bits available.

static void SoStencilBitsElement::clearBitsInUse

(

SoState *

state

)

[static]

This is required e.g. for framebuffer objects which use the same GL context but have a different stencil buffer. In that case the currently aquired stencil bits are not valid for this buffer. The programmer must then clear the used stencil bits of the element.

static uint32_t SoStencilBitsElement::get

(

SoState *

state

)

[inline, static]

Definition at line 80 of file SoStencilBitsElement.h.

References SoInt32Element::get().

static uint32_t SoStencilBitsElement::getDefault

(

)

[inline, static]

Definition at line 85 of file SoStencilBitsElement.h.

static int SoStencilBitsElement::getNumBitPositionsToShift	(	uint32_t	mask,
		SoState *	state
	)		[static, protected]

int SoStencilBitsElement::getNumGLBits

(

)

const [protected]

static int SoStencilBitsElement::getNumRemainingBits

(

SoState *

state

)

[static]

virtual void SoStencilBitsElement::init

(

SoState *

state

)

[virtual]

Reimplemented from SoElement.

static void SoStencilBitsElement::initClass

(

)

[static]

Reimplemented from SoInt32Element.

Reimplemented in SoGLStencilBitsElement.

virtual void SoStencilBitsElement::push

(

SoState *

state

)

[virtual]

Reimplemented from SoElement.

static void SoStencilBitsElement::releaseBits	(	SoState *	state,
		uint32_t	mask
	)		[static]

---

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

• MeVis/ThirdParty/Sources/Inventor/inventor/lib/mevis/include/Inventor/elements/SoStencilBitsElement.h