SoGLColorIndexElement(3)

💅 SoGLColorIndexElement — from the Coin manual, section 3

okay bestie, sit DOWN because we're about to talk about the little class that tells OpenGL what color to be. yes it's a whole vibe. no cap. ✨

---

🌸 NAME

SoGLColorIndexElement — the class that sets the current OpenGL color. that's it, that's the whole job, and she does it fabulously 💖

---

🦋 SYNOPSIS

#include <Inventor/elements/SoGLColorIndexElement.h>

Inherits SoReplacedElement.

---

👑 Public Member Functions

• virtual void init(SoState *state)
• int32_t getNum(void) const
• int32_t get(const int index) const

🎀 Public Member Functions inherited from SoReplacedElement

• virtual SbBool matches(const SoElement *element) const
• virtual SoElement * copyMatchInfo() const
• SbUniqueId getNodeId() const
• virtual void print(FILE *file) const

🎀 Public Member Functions inherited from SoElement

• const SoType getTypeId(void) const
• int getStackIndex(void) const
• virtual void push(SoState *state)
• virtual void pop(SoState *state, const SoElement *prevTopElement)
• void setDepth(const int depth)
• int getDepth(void) 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 isColorIndexMode(SoState *state)
• static void set(SoState *const state, SoNode *const node, const int32_t numindices, const int32_t *const indices)
• static const SoGLColorIndexElement * getInstance(SoState *state)
• static int32_t getDefault(void)

🎀 Static Public Member Functions inherited from SoReplacedElement

• static SoType getClassTypeId(void)
• static int getClassStackIndex(void)
• static void initClass(void)

🎀 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

• virtual ~SoGLColorIndexElement()

🎀 Protected Member Functions inherited from SoReplacedElement

• virtual ~SoReplacedElement()

🎀 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)
• SoElement * getNextInStack(void) const
• SoElement * getNextFree(void) const

---

🌈 Additional Inherited Members

🎀 Static Protected Member Functions inherited from SoReplacedElement

• static SoElement * getElement(SoState *const state, const int stackIndex, SoNode *const node)

🎀 Static Protected Member Functions inherited from SoElement

• static SoElement * getElement(SoState *const state, const int stackIndex)
• static const SoElement * getConstElement(SoState *const state, const int stackIndex)
• static int createStackIndex(const SoType id)

🎀 Protected Attributes inherited from SoReplacedElement

• SbUniqueId nodeId

🎀 Protected Attributes inherited from SoElement

• SoType typeId
• int stackIndex
• int depth

🎀 Static Protected Attributes inherited from SoElement

• static int classStackIndex
• static SoTypeList * stackToType

---

💖 Detailed Description

The SoGLColorIndexElement class sets the current OpenGL color. literally her entire personality, and we respect it 🫶

now here's the tea: 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 — that's the normie path and honestly it's fine.

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. so like, conditional. check your hardware first, bestie 💅

See also SoColorIndex

---

🧚 Constructor & Destructor Documentation

SoGLColorIndexElement::~SoGLColorIndexElement() [protected], [virtual]

Destructor. she's leaving, say goodbye 😭

---

⭐ Member Function Documentation

SoType SoGLColorIndexElement::getClassTypeId(void) [static]

This static method returns the SoType object associated with objects of this class. like a lil name tag for the type system 🏷️

int SoGLColorIndexElement::getClassStackIndex(void) [static]

This static method returns the state stack index for the class.

void * SoGLColorIndexElement::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. iykyk, don't touch unless you live there 🙈

Creates a new instance of the class type corresponding to the SoType object.

void SoGLColorIndexElement::initClass(void) [static]

Initialize relevant common data for all instances, like the type system. the glow-up setup ✨

SbBool SoGLColorIndexElement::isColorIndexMode(SoState *state) [static]

Returns TRUE if the current GL context is in color index mode. vibe check on the GL context 🕵️

void SoGLColorIndexElement::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 SoReplacedElement.

void SoGLColorIndexElement::set(SoState *const state, SoNode *const node, const int32_t numindices, const int32_t *const indices) [static]

Sets current color indices. manifesting colors fr fr 🌈

const SoGLColorIndexElement * SoGLColorIndexElement::getInstance(SoState *state) [static]

Returns the current element. the one, the only, the main character 👑

int32_t SoGLColorIndexElement::getNum(void) const

Returns number of color indices in element. counting, but make it glam 💅

int32_t SoGLColorIndexElement::get(const int index) const

Returns the index'th color index in element. zero-based bestie, you know the drill.

int32_t SoGLColorIndexElement::getDefault(void) [static]

Returns the default color index in element. the fallback fit when nobody picks an outfit 🎀

---

🌸 Author

Generated automatically by Doxygen for Coin from the source code. not a human, just a very diligent robot doing its lil documentation chores 🤖✨

---

and that's the whole page, bestie!! this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and she's filed under SoGLColorIndexElement(3) in the Coin manual. slay, stay colorful, and remember: RGBA true color is the normie path and it's fine 💖🌈🦋