Open Inventor Reference
SoGLStencilBitsElement Class Reference

#include <Inventor/elements/SoGLStencilBitsElement.h>

Inheritance diagram for SoGLStencilBitsElement:
SoStencilBitsElement SoInt32Element SoElement

Static Public Member Functions

static void clear (SoState *state, uint32_t mask, int32_t value=0)
 Clears only the masked bits (which must be adjacent) to value.
 
static void initClass ()
 Initializes the SoGLStencilBitsElement class.
 
- Static Public Member Functions inherited from SoStencilBitsElement
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.
 
- Static Public Member Functions inherited from SoInt32Element
static void initClass ()
 Initializes the SoInt32Element class.
 
static void set (int stackIndex, SoState *state, int32_t value)
 Set value.
 
static void set (int stackIndex, SoState *state, SoNode *, int32_t value)
 
static void set (int stackIndex, SoState *state, SoNode *, long value)
 
static int32_t get (int stackIndex, SoState *state)
 Get value.
 
- Static Public Member Functions inherited from SoElement
static SoType getClassTypeId ()
 Returns type identifier for SoElement class.
 
static void initElements ()
 Initialize ALL Inventor element classes.
 
static void initClass ()
 Initializes the SoElement class.
 
static int getNumStackIndices ()
 Returns the number of stack indices allocated.
 
static SoType getIdFromStackIndex (int stackIndex)
 Returns the id for the element with the given stack index.
 

Protected Member Functions

virtual ~SoGLStencilBitsElement ()
 Destructor.
 
- Protected Member Functions inherited from SoStencilBitsElement
virtual ~SoStencilBitsElement ()
 Destructor.
 
int getNumGLBits () const
 Returns the number of bits supported by GL implementation.
 
- Protected Member Functions inherited from SoInt32Element
virtual ~SoInt32Element ()
 
- Protected Member Functions inherited from SoElement
 SoElement ()
 Constructor; use typeId.createInstance to create elements.
 
void capture (SoState *state) const
 Does whatever is necessary in state to capture this element for caching purposes.
 
virtual void captureThis (SoState *state) const
 Really captures this element, once it has been determined that a cache is open to capture it.
 
void setTypeId (SoType id)
 Sets typeId in instance.
 
void setStackIndex (int index)
 Sets stackIndex in instance.
 
SoElementgetNextInStack () const
 Returns next instance in specific element stack.
 
SoElementgetNextFree () const
 Returns next free element in a specific element stack.
 

Additional Inherited Members

- Public Member Functions inherited from SoStencilBitsElement
virtual void init (SoState *state)
 Initializes element.
 
virtual void push (SoState *state)
 Overrides push() method to copy values from next instance in the stack.
 
- Public Member Functions inherited from SoInt32Element
virtual bool matches (const SoElement *elt) const
 Comparison based on value of int32_ts.
 
virtual SoElementcopyMatchInfo () const
 Copy method, takes care copying the data.
 
virtual void setElt (int32_t value)
 Virtual set that subclasses can override to implement side-effect behaviors.
 
virtual void print (FILE *fp) const
 Prints element (for debugging)
 
- Public Member Functions inherited from SoElement
virtual void init (SoState *state)
 Initializes element.
 
virtual void push (SoState *state)
 Pushes/pops element.
 
virtual void pop (SoState *state, const SoElement *prevTopElement)
 
virtual void print (FILE *fp) const
 Prints element (for debugging)
 
virtual bool matches (const SoElement *elt) const =0
 Returns TRUE if the element matches another element (of the same class, presumably) with respect to cache validity.
 
virtual SoElementcopyMatchInfo () const =0
 Create a copy that we can put in a cache used list and call matches() on later.
 
SoType getTypeId () const
 Returns type identifier for element instance.
 
int getStackIndex () const
 Returns the stack index for an element instance.
 
void setDepth (int dpth)
 Sets stuff in an element instance.
 
void setNext (SoElement *nxt)
 
void setNextInStack (SoElement *nxt)
 
void setNextFree (SoElement *nxt)
 
int getDepth () const
 Returns stuff from element instance.
 
SoElementgetNext () const
 
virtual ~SoElement ()
 Destructor.
 
- Static Protected Member Functions inherited from SoStencilBitsElement
static int getNumBitPositionsToShift (uint32_t mask, SoState *state)
 Number of positions a value must be shifted according to mask.
 
- Static Protected Member Functions inherited from SoElement
static SoElementgetElement (SoState *state, int stackIndex)
 Returns an instance of an element from the stack with the given index in the given state.
 
static const SoElementgetConstElement (SoState *state, int stackIndex)
 Returns a read-only pointer to the top instance in the given element stack.
 
static int createStackIndex (SoType id)
 Creates and returns a new stack index.
 
- Protected Attributes inherited from SoInt32Element
int32_t data
 Storage for data.
 
- Static Protected Attributes inherited from SoElement
static int classStackIndex
 Stack index for SoElement class.
 

Detailed Description

Definition at line 9 of file SoGLStencilBitsElement.h.

Constructor & Destructor Documentation

◆ ~SoGLStencilBitsElement()

virtual SoGLStencilBitsElement::~SoGLStencilBitsElement ( )
protectedvirtual

Member Function Documentation

◆ clear()

static void SoGLStencilBitsElement::clear ( SoState state,
uint32_t  mask,
int32_t  value = 0 
)
static

Value is shifted automatically to fit in the masked bits.

◆ initClass()

static void SoGLStencilBitsElement::initClass ( )
static

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