.TH "SoGLVBOElement" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoGLVBOElement \- The \fBSoGLVBOElement\fP class is used to store VBO state\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoElement\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBinit\fP (\fBSoState\fP *state)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBpush\fP (\fBSoState\fP *state)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBpop\fP (\fBSoState\fP *state, \fBconst\fP \fBSoElement\fP *\fBprevtopelement\fP)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBmatches\fP (\fBconst\fP \fBSoElement\fP *\fBelt\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBSoElement\fP * \fBcopyMatchInfo\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBSoVBO\fP * \fBgetVertexVBO\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBSoVBO\fP * \fBgetNormalVBO\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBSoVBO\fP * \fBgetColorVBO\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "int \fBgetNumTexCoordVBO\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBSoVBO\fP * \fBgetTexCoordVBO\fP (\fBconst\fP int idx) \fBconst\fP" .br .in -1c Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBconst\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "int \fBgetStackIndex\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBsetDepth\fP (\fBconst\fP int \fBdepth\fP)" .br .ti -1c .RI "int \fBgetDepth\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBprint\fP (\fBFILE\fP *\fBfile\fP=\fBstdout\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fB~SoElement\fP ()" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP * \fBcreateInstance\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBshouldCreateVBO\fP (\fBSoState\fP *state, \fBconst\fP int \fBnumdata\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBsetVertexVBO\fP (\fBSoState\fP *state, \fBSoVBO\fP *vbo)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBsetNormalVBO\fP (\fBSoState\fP *state, \fBSoVBO\fP *vbo)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBsetColorVBO\fP (\fBSoState\fP *state, \fBSoVBO\fP *vbo)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBsetTexCoordVBO\fP (\fBSoState\fP *state, \fBconst\fP int unit, \fBSoVBO\fP *vbo)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoGLVBOElement\fP * \fBgetInstance\fP (\fBSoState\fP *state)" .br .in -1c Static Public Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitElements\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetNumStackIndices\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetIdFromStackIndex\fP (\fBconst\fP int \fBstackIndex\fP)" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "\fBSoGLVBOElement\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fB~SoGLVBOElement\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoElement\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvoid\fP \fBcapture\fP (\fBSoState\fP *\fBconst\fP state) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBcaptureThis\fP (\fBSoState\fP *state) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBsetTypeId\fP (\fBconst\fP \fBSoType\fP \fBtypeId\fP)" .br .ti -1c .RI "\fBvoid\fP \fBsetStackIndex\fP (\fBconst\fP int index)" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextInStack\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBSoElement\fP * \fBgetNextFree\fP (\fBvoid\fP) \fBconst\fP" .br .in -1c .SS "Static Protected Member Functions" .in +1c .ti -1c .RI "\fBstatic\fP \fBSoGLVBOElement\fP * \fBgetElement\fP (\fBSoState\fP *state)" .br .in -1c Static Protected Member Functions inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoElement\fP * \fBgetConstElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBcreateStackIndex\fP (\fBconst\fP \fBSoType\fP id)" .br .in -1c .SS "Additional Inherited Members" Protected Attributes inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBSoType\fP \fBtypeId\fP" .br .ti -1c .RI "int \fBstackIndex\fP" .br .ti -1c .RI "int \fBdepth\fP" .br .in -1c Static Protected Attributes inherited from \fBSoElement\fP .in +1c .ti -1c .RI "\fBstatic\fP int \fBclassStackIndex\fP" .br .ti -1c .RI "\fBstatic\fP \fBSoTypeList\fP * \fBstackToType\fP" .br .in -1c .SH "Detailed Description" .PP The \fBSoGLVBOElement\fP class is used to store VBO state\&. FIXME: write doc\&. .PP Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor \fBv2\&.1\fP API\&. .br .PP \fBSince\fP .RS 4 Coin \fB2\&.5\fP .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoGLVBOElement::SoGLVBOElement (\fBvoid\fP)\fC [protected]\fP" Constructor\&. .SS "SoGLVBOElement::~SoGLVBOElement ()\fC [protected]\fP, \fC [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoGLVBOElement::getClassTypeId (\fBvoid\fP)\fC [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "int SoGLVBOElement::getClassStackIndex (\fBvoid\fP)\fC [static]\fP" This static method returns the state stack index for the class\&. .br .SS "\fBvoid\fP * SoGLVBOElement::createInstance (\fBvoid\fP)\fC [static]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br Creates a new instance of the class type corresponding to the \fBSoType\fP object\&. .br .SS "\fBvoid\fP SoGLVBOElement::initClass (\fBvoid\fP)\fC [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "SbBool SoGLVBOElement::shouldCreateVBO (\fBSoState\fP * state, \fBconst\fP int numdata)\fC [static]\fP" Returns \fITRUE\fP if VBO is supported for the current context, and if numdata is between the limits set for VBO rendering\&. .SS "\fBvoid\fP SoGLVBOElement::setVertexVBO (\fBSoState\fP * state, \fBSoVBO\fP * vbo)\fC [static]\fP" Sets the vertex VBO\&. .SS "\fBvoid\fP SoGLVBOElement::setNormalVBO (\fBSoState\fP * state, \fBSoVBO\fP * vbo)\fC [static]\fP" Sets the normal VBO\&. .SS "\fBvoid\fP SoGLVBOElement::setColorVBO (\fBSoState\fP * state, \fBSoVBO\fP * vbo)\fC [static]\fP" Sets the color VBO\&. .SS "\fBvoid\fP SoGLVBOElement::setTexCoordVBO (\fBSoState\fP * state, \fBconst\fP int unit, \fBSoVBO\fP * vbo)\fC [static]\fP" Sets the texture coordinate VBO\&. .SS "\fBconst\fP \fBSoGLVBOElement\fP * SoGLVBOElement::getInstance (\fBSoState\fP * state)\fC [static]\fP" Returns a read-only element instance\&. .SS "\fBvoid\fP SoGLVBOElement::init (\fBSoState\fP * state)\fC [virtual]\fP" This function initializes the element type in the given \fBSoState\fP\&. It is called for the first element of each enabled element type in \fBSoState\fP objects\&. .PP Reimplemented from \fBSoElement\fP\&. .SS "\fBvoid\fP SoGLVBOElement::push (\fBSoState\fP * state)\fC [virtual]\fP" 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 \fBSoState::getElement()\fP or indirectly \fBSoElement::getElement()\fP, and the depth of the current element is less than the state depth\&. .PP Override this method if your element needs to copy data from the previous top of stack\&. The \fBpush()\fP method is called on the new element, and the previous element can be found using \fBSoElement::getNextInStack()\fP\&. .PP Reimplemented from \fBSoElement\fP\&. .SS "\fBvoid\fP SoGLVBOElement::pop (\fBSoState\fP * state, \fBconst\fP \fBSoElement\fP * prevTopElement)\fC [virtual]\fP" This method is called when the state is popped, and the depth of the element is bigger than the current state depth\&. \fBpop()\fP is called on the new top of stack, and a pointer to the previous top of stack is passed in \fIprevTopElement\fP\&. .PP Override this method if you need to copy some state information from the previous top of stack\&. .PP Reimplemented from \fBSoElement\fP\&. .SS "SbBool SoGLVBOElement::matches (\fBconst\fP \fBSoElement\fP * element) const\fC [virtual]\fP" This function returns \fCTRUE\fP is the element matches another element (of the same class), with respect to cache validity\&. .PP If the application programmer's extension element has a \fBmatches()\fP function, it should also have a \fBcopyMatchInfo()\fP function\&. .PP Implements \fBSoElement\fP\&. .SS "\fBSoElement\fP * SoGLVBOElement::copyMatchInfo (\fBvoid\fP) const\fC [virtual]\fP" This function creates a copy of the element that contains enough information to enable the \fBmatches()\fP function to work\&. .PP Used to help with scene graph traversal caching operations\&. .PP Implements \fBSoElement\fP\&. .SS "\fBSoGLVBOElement\fP * SoGLVBOElement::getElement (\fBSoState\fP * state)\fC [static]\fP, \fC [protected]\fP" Returns a writable element instance\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.