.TH "SoGLShaderProgramElement" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "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 "virtual void \fBinit\fP (\fBSoState\fP *state)"
.br
.ti -1c
.RI "virtual void \fBpush\fP (\fBSoState\fP *)"
.br
.ti -1c
.RI "virtual void \fBpop\fP (\fBSoState\fP *state, const \fBSoElement\fP *prevTopElement)"
.br
.ti -1c
.RI "virtual SbBool \fBmatches\fP (const \fBSoElement\fP *element) const"
.br
.ti -1c
.RI "virtual \fBSoElement\fP * \fBcopyMatchInfo\fP () const"
.br
.in -1c

Public Member Functions inherited from \fBSoReplacedElement\fP
.in +1c
.ti -1c
.RI "SbUniqueId \fBgetNodeId\fP () const"
.br
.ti -1c
.RI "virtual void \fBprint\fP (FILE *file) const"
.br
.in -1c

Public Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "const \fBSoType\fP \fBgetTypeId\fP (void) const"
.br
.ti -1c
.RI "int \fBgetStackIndex\fP (void) const"
.br
.ti -1c
.RI "void \fBsetDepth\fP (const int \fBdepth\fP)"
.br
.ti -1c
.RI "int \fBgetDepth\fP (void) const"
.br
.ti -1c
.RI "virtual \fB~SoElement\fP ()"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static int \fBgetClassStackIndex\fP (void)"
.br
.ti -1c
.RI "static void * \fBcreateInstance\fP (void)"
.br
.ti -1c
.RI "static void \fBenable\fP (\fBSoState\fP *const state, const SbBool onoff)"
.br
.ti -1c
.RI "static void \fBset\fP (\fBSoState\fP *const state, \fBSoNode\fP *const node, SoGLShaderProgram *program)"
.br
.ti -1c
.RI "static SoGLShaderProgram * \fBget\fP (\fBSoState\fP *state)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoReplacedElement\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static int \fBgetClassStackIndex\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static int \fBgetClassStackIndex\fP (void)"
.br
.ti -1c
.RI "static void \fBinitElements\fP (void)"
.br
.ti -1c
.RI "static int \fBgetNumStackIndices\fP (void)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetIdFromStackIndex\fP (const 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 "virtual \fB~SoReplacedElement\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "\fBSoElement\fP (void)"
.br
.ti -1c
.RI "void \fBcapture\fP (\fBSoState\fP *const state) const"
.br
.ti -1c
.RI "virtual void \fBcaptureThis\fP (\fBSoState\fP *state) const"
.br
.ti -1c
.RI "void \fBsetTypeId\fP (const \fBSoType\fP \fBtypeId\fP)"
.br
.ti -1c
.RI "void \fBsetStackIndex\fP (const int index)"
.br
.ti -1c
.RI "\fBSoElement\fP * \fBgetNextInStack\fP (void) const"
.br
.ti -1c
.RI "\fBSoElement\fP * \fBgetNextFree\fP (void) const"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoReplacedElement\fP
.in +1c
.ti -1c
.RI "static \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP, \fBSoNode\fP *const node)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "static \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP)"
.br
.ti -1c
.RI "static const \fBSoElement\fP * \fBgetConstElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP)"
.br
.ti -1c
.RI "static int \fBcreateStackIndex\fP (const \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 "static int \fBclassStackIndex\fP"
.br
.ti -1c
.RI "static \fBSoTypeList\fP * \fBstackToType\fP"
.br
.in -1c
.SH "Member Function Documentation"
.PP 
.SS "virtual void SoGLShaderProgramElement::init (\fBSoState\fP * state)\fR [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 "virtual void SoGLShaderProgramElement::push (\fBSoState\fP * state)\fR [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 "virtual void SoGLShaderProgramElement::pop (\fBSoState\fP * state, const \fBSoElement\fP * prevTopElement)\fR [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 "virtual SbBool SoGLShaderProgramElement::matches (const \fBSoElement\fP * element) const\fR [virtual]\fP"
This function returns \fRTRUE\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 "virtual \fBSoElement\fP * SoGLShaderProgramElement::copyMatchInfo (void ) const\fR [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\&.