.TH "SoGLColorIndexElement" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoGLColorIndexElement \- The \fBSoGLColorIndexElement\fP class sets the current OpenGL color\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .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 "int32_t \fBgetNum\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "int32_t \fBget\fP (\fBconst\fP int index) \fBconst\fP" .br .in -1c Public Member Functions inherited from \fBSoReplacedElement\fP .in +1c .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 .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 "\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 "\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 \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBisColorIndexMode\fP (\fBSoState\fP *state)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBset\fP (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, \fBconst\fP int32_t \fBnumindices\fP, \fBconst\fP int32_t *\fBconst\fP indices)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoGLColorIndexElement\fP * \fBgetInstance\fP (\fBSoState\fP *state)" .br .ti -1c .RI "\fBstatic\fP int32_t \fBgetDefault\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 "Protected Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoGLColorIndexElement\fP ()" .br .in -1c 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 .SS "Additional Inherited Members" 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 "Detailed Description" .PP The \fBSoGLColorIndexElement\fP class sets the current OpenGL color\&. This element is only used when the OpenGL canvas is in color index mode, i\&.e\&. where colors for individual pixels are fetched from a color lookup table ('CLUT')\&. The usual thing to do is to set up a canvas in RGBA true color mode\&. .PP One common use for color index mode OpenGL canvases is to use one in the overlay planes (which are usually limited to only 2 or 4 available colors), if supported by the OpenGL hardware and / or driver\&. .PP \fBSee also\fP .RS 4 \fBSoColorIndex\fP .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoGLColorIndexElement::~SoGLColorIndexElement ()\fC [protected]\fP, \fC [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoGLColorIndexElement::getClassTypeId (\fBvoid\fP)\fC [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "int SoGLColorIndexElement::getClassStackIndex (\fBvoid\fP)\fC [static]\fP" This static method returns the state stack index for the class\&. .br .SS "\fBvoid\fP * SoGLColorIndexElement::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 SoGLColorIndexElement::initClass (\fBvoid\fP)\fC [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "SbBool SoGLColorIndexElement::isColorIndexMode (\fBSoState\fP * state)\fC [static]\fP" Returns \fCTRUE\fP if the current GL context is in color index mode\&. .SS "\fBvoid\fP SoGLColorIndexElement::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 "\fBvoid\fP SoGLColorIndexElement::set (\fBSoState\fP *\fBconst\fP state, \fBSoNode\fP *\fBconst\fP node, \fBconst\fP int32_t numindices, \fBconst\fP int32_t *\fBconst\fP indices)\fC [static]\fP" Sets current color indices\&. .SS "\fBconst\fP \fBSoGLColorIndexElement\fP * SoGLColorIndexElement::getInstance (\fBSoState\fP * state)\fC [static]\fP" Returns the current element\&. .SS "int32_t SoGLColorIndexElement::getNum (\fBvoid\fP) const" Returns number of color indices in element\&. .SS "int32_t SoGLColorIndexElement::get (\fBconst\fP int index) const" Returns the index'th color index in element\&. .SS "int32_t SoGLColorIndexElement::getDefault (\fBvoid\fP)\fC [static]\fP" Returns the default color index in element\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.