Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoGLVBOElement Class Reference

The SoGLVBOElement class is used to store VBO state. More...

#include <Inventor/elements/SoGLVBOElement.h>

Inheritance diagram for SoGLVBOElement:
SoElement

Public Member Functions

virtual void init (SoState *state)
 
virtual void push (SoState *state)
 
virtual void pop (SoState *state, const SoElement *prevtopelement)
 
virtual SbBool matches (const SoElement *elt) const
 
virtual SoElementcopyMatchInfo (void) const
 
SoVBO * getVertexVBO (void) const
 
SoVBO * getNormalVBO (void) const
 
SoVBO * getColorVBO (void) const
 
int getNumTexCoordVBO (void) const
 
SoVBO * getTexCoordVBO (const int idx) const
 
- Public Member Functions inherited from SoElement
const SoType getTypeId (void) const
 
int getStackIndex (void) const
 
void setDepth (const int depth)
 
int getDepth (void) const
 
virtual void print (FILE *file=stdout) const
 
virtual ~SoElement ()
 

Static Public Member Functions

static SoType getClassTypeId (void)
 
static int getClassStackIndex (void)
 
static void * createInstance (void)
 
static void initClass (void)
 
static SbBool shouldCreateVBO (SoState *state, const int numdata)
 
static void setVertexVBO (SoState *state, SoVBO *vbo)
 
static void setNormalVBO (SoState *state, SoVBO *vbo)
 
static void setColorVBO (SoState *state, SoVBO *vbo)
 
static void setTexCoordVBO (SoState *state, const int unit, SoVBO *vbo)
 
static const SoGLVBOElementgetInstance (SoState *state)
 
- Static Public Member Functions inherited from SoElement
static void initClass (void)
 
static SoType getClassTypeId (void)
 
static int getClassStackIndex (void)
 
static void initElements (void)
 
static int getNumStackIndices (void)
 
static SoType getIdFromStackIndex (const int stackIndex)
 

Protected Member Functions

 SoGLVBOElement (void)
 
virtual ~SoGLVBOElement ()
 
- Protected Member Functions inherited from SoElement
 SoElement (void)
 
void capture (SoState *const state) const
 
virtual void captureThis (SoState *state) const
 
void setTypeId (const SoType typeId)
 
void setStackIndex (const int index)
 
SoElementgetNextInStack (void) const
 
SoElementgetNextFree (void) const
 

Static Protected Member Functions

static SoGLVBOElementgetElement (SoState *state)
 
- Static Protected Member Functions inherited from SoElement
static SoElementgetElement (SoState *const state, const int stackIndex)
 
static const SoElementgetConstElement (SoState *const state, const int stackIndex)
 
static int createStackIndex (const SoType id)
 

Additional Inherited Members

- Protected Attributes inherited from SoElement
SoType typeId
 
int stackIndex
 
int depth
 
- Static Protected Attributes inherited from SoElement
static int classStackIndex
 
static SoTypeListstackToType
 

Detailed Description

The SoGLVBOElement class is used to store VBO state.

FIXME: write doc.

Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since
Coin 2.5

Constructor & Destructor Documentation

◆ SoGLVBOElement()

SoGLVBOElement::SoGLVBOElement ( void  )
protected

The constructor.

◆ ~SoGLVBOElement()

SoGLVBOElement::~SoGLVBOElement ( )
protectedvirtual

The destructor.

Member Function Documentation

◆ createInstance()

void * SoGLVBOElement::createInstance ( void  )
static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

◆ initClass()

void SoGLVBOElement::initClass ( void  )
static

This static method initializes static data for the SoGLVBOElement class.

◆ shouldCreateVBO()

SbBool SoGLVBOElement::shouldCreateVBO ( SoState state,
const int  numdata 
)
static

Returns TRUE if VBO is supported for the current context, and if numdata is between the limits set for VBO rendering.

◆ setVertexVBO()

void SoGLVBOElement::setVertexVBO ( SoState state,
SoVBO *  vbo 
)
static

Sets the vertex VBO.

◆ setNormalVBO()

void SoGLVBOElement::setNormalVBO ( SoState state,
SoVBO *  vbo 
)
static

Sets the normal VBO.

◆ setColorVBO()

void SoGLVBOElement::setColorVBO ( SoState state,
SoVBO *  vbo 
)
static

Sets the color VBO.

◆ setTexCoordVBO()

void SoGLVBOElement::setTexCoordVBO ( SoState state,
const int  unit,
SoVBO *  vbo 
)
static

Sets the texture coordinate VBO.

◆ getInstance()

const SoGLVBOElement * SoGLVBOElement::getInstance ( SoState state)
static

Returns a read-only element instance.

◆ init()

void SoGLVBOElement::init ( SoState state)
virtual

This function initializes the element type in the given SoState. It is called for the first element of each enabled element type in SoState objects.

Reimplemented from SoElement.

◆ push()

void SoGLVBOElement::push ( SoState state)
virtual

This method is called every time a new element is required in one of the stacks. This happens when a writable element is requested, using SoState::getElement() or indirectly SoElement::getElement(), and the depth of the current element is less than the state depth.

Override this method if your element needs to copy data from the previous top of stack. The push() method is called on the new element, and the previous element can be found using SoElement::getNextInStack().

Reimplemented from SoElement.

◆ pop()

void SoGLVBOElement::pop ( SoState state,
const SoElement prevTopElement 
)
virtual

This method is called when the state is popped, and the depth of the element is bigger than the current state depth. pop() is called on the new top of stack, and a pointer to the previous top of stack is passed in prevTopElement.

Override this method if you need to copy some state information from the previous top of stack.

Reimplemented from SoElement.

◆ matches()

SbBool SoGLVBOElement::matches ( const SoElement element) const
virtual

This function returns TRUE is the element matches another element (of the same class), with respect to cache validity.

If the application programmer's extension element has a matches() function, it should also have a copyMatchInfo() function.

Implements SoElement.

◆ copyMatchInfo()

SoElement * SoGLVBOElement::copyMatchInfo ( void  ) const
virtual

This function creates a copy of the element that contains enough information to enable the matches() function to work.

Used to help with scene graph traversal caching operations.

Implements SoElement.

◆ getElement()

SoGLVBOElement * SoGLVBOElement::getElement ( SoState state)
staticprotected

Returns a writable element instance.


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