.TH "SoGLShaderProgramElement" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoGLShaderProgramElement
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBSoReplacedElement\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 *)"
.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 *element) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoElement\fP * \fBcopyMatchInfo\fP () \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoReplacedElement\fP
.in +1c
.ti -1c
.RI "SbUniqueId \fBgetNodeId\fP () \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBprint\fP (\fBFILE\fP *\fBfile\fP) \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 \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 \fBenable\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP SbBool \fBonoff\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBset\fP (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, SoGLShaderProgram *\fBprogram\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SoGLShaderProgram * \fBget\fP (\fBSoState\fP *state)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoReplacedElement\fP
.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 \fBinitClass\fP (\fBvoid\fP)"
.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 "Public Attributes"

.in +1c
.ti -1c
.RI "SoGLShaderProgram * \fBshaderProgram\fP"
.br
.in -1c
.SS "Additional Inherited Members"


Protected Member Functions inherited from \fBSoReplacedElement\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fB~SoReplacedElement\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

Static Protected Member Functions inherited from \fBSoReplacedElement\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP int \fBstackIndex\fP, \fBSoNode\fP *\fBconst\fP node)"
.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

Protected Attributes inherited from \fBSoReplacedElement\fP
.in +1c
.ti -1c
.RI "SbUniqueId \fBnodeId\fP"
.br
.in -1c

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 "Member Function Documentation"
.PP 
.SS "\fBvirtual\fP \fBvoid\fP SoGLShaderProgramElement::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 \fBSoReplacedElement\fP\&.
.SS "\fBvirtual\fP \fBvoid\fP SoGLShaderProgramElement::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 "\fBvirtual\fP \fBvoid\fP SoGLShaderProgramElement::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 "\fBvirtual\fP SbBool SoGLShaderProgramElement::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
Reimplemented from \fBSoReplacedElement\fP\&.
.SS "\fBvirtual\fP \fBSoElement\fP * SoGLShaderProgramElement::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
Reimplemented from \fBSoReplacedElement\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.