Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoGLColorIndexElement Class Reference

The SoGLColorIndexElement class sets the current OpenGL color. More...

#include <Inventor/elements/SoGLColorIndexElement.h>

Inheritance diagram for SoGLColorIndexElement:
SoReplacedElement SoElement

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 SoElementcopyMatchInfo () 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 SoGLColorIndexElementgetInstance (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)
 
SoElementgetNextInStack (void) const
 
SoElementgetNextFree (void) const
 

Additional Inherited Members

- Static Protected Member Functions inherited from SoReplacedElement
static SoElementgetElement (SoState *const state, const int stackIndex, SoNode *const node)
 
- Static Protected Member Functions inherited from SoElement
static SoElementgetElement (SoState *const state, const int stackIndex)
 
static const SoElementgetConstElement (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 SoTypeListstackToType
 

Detailed Description

The SoGLColorIndexElement 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.

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.

See also
SoColorIndex

Constructor & Destructor Documentation

◆ ~SoGLColorIndexElement()

SoGLColorIndexElement::~SoGLColorIndexElement ( )
protectedvirtual

The destructor.

Member Function Documentation

◆ createInstance()

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.

◆ isColorIndexMode()

SbBool SoGLColorIndexElement::isColorIndexMode ( SoState state)
static

Returns TRUE if the current GL context is in color index mode.

◆ init()

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.

◆ set()

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

Sets current color indices.

◆ getInstance()

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

Returns the current element.

◆ getNum()

int32_t SoGLColorIndexElement::getNum ( void  ) const

Returns number of color indices in element.


The documentation for this class was generated from the following files: