SoTextureCombineElement(3)

SoTextureCombineElement(3) — Library Functions Manual 💖

okay bestie, this is the manual page for SoTextureCombineElement(3) from the Library Functions Manual. It's giving Coin element energy, and we're about to go through every single detail like it's a group chat. No cap. 🦋

---

✨ NAME ✨

SoTextureCombineElement — the SoTextureCombineElement class is yet to be documented. 😭

---

🌈 SYNOPSIS 🌈

#include <Inventor/elements/SoTextureCombineElement.h>

Inherits SoElement.

🎀 Public Types 🎀

The enum lineup is iconic, no cap:

enum Source { PRIMARY_COLOR = 0x8577, TEXTURE = 0x1702, CONSTANT =
    0x8576, PREVIOUS = 0x8578 }
enum Operand { SRC_COLOR = 0x0300, ONE_MINUS_SRC_COLOR = 0x0301,
    SRC_ALPHA = 0x0302, ONE_MINUS_SRC_ALPHA = 0x0303 }
enum Operation { REPLACE = 0x1E01, MODULATE = 0x2100, ADD = 0x0104,
    ADD_SIGNED = 0x8574, SUBTRACT = 0x84E7, INTERPOLATE = 0x8575,
    DOT3_RGB = 0x86AE, DOT3_RGBA = 0x86AF }

💅 Public Member Functions 💅

Here's the main-character function list:

virtual void init (SoState *state)
virtual void push (SoState *state)
virtual SbBool matches (const SoElement *elem) const
SoElement * copyMatchInfo (void) const
virtual void setElt (const int unit, const uint32_t nodeid, const
    Operation rgboperation, const Operation alphaoperation, const Source
    *rgbsource, const Source *alphasource, const Operand *rgboperand,
    const Operand *alphaoperand, const SbColor4f &constantcolor, const
    float rgbscale, const float alphascale)

• init — FIXME: write doc.
• setElt — FIXME: write doc.

🫶 Public Member Functions inherited from SoElement 🫶

const SoType getTypeId (void) const
int getStackIndex (void) const
virtual void pop (SoState *state, const SoElement *prevTopElement)
void setDepth (const int depth)
int getDepth (void) const
virtual void print (FILE *file=stdout) const
virtual ~SoElement ()

✨ Static Public Member Functions ✨

static SoType getClassTypeId (void)
static int getClassStackIndex (void)
static void * createInstance (void)
static void initClass (void)
static void set (SoState *const state, SoNode *const node, const int
    unit, const Operation rgboperation, const Operation alphaoperation,
    const Source *rgbsource, const Source *alphasource, const Operand
    *rgboperand, const Operand *alphaoperand, const SbColor4f
    &constantcolor, const float rgbscale, const float alphascale)
static SbBool isDefault (SoState *const state, const int unit)
static void get (SoState *const state, const int unit, Operation
    &rgboperation, Operation &alphaoperation, Source *rgbsource, Source
    *alphasource, Operand *rgboperand, Operand *alphaoperand, SbColor4f
    &constantcolor, float &rgbscale, float &alphascale)
static void apply (SoState *state, const int unit)

• set — FIXME: write doc.
• get — FIXME: write doc.

💜 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 ~SoTextureCombineElement ()
const UnitData & getUnitData (const int unit) const

🧚 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 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 SoElement 🍓

SoType typeId
int stackIndex
int depth

🌈 Static Protected Attributes inherited from SoElement 🌈

static int classStackIndex
static SoTypeList * stackToType

---

🌟 Detailed Description 🌟

The SoTextureCombineElement class is yet to be documented. 😭

FIXME: write doc.

Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. (so don't go looking for it there, bestie 💀)

Since: Coin 2.3

---

🎀 Constructor & Destructor Documentation 🎀

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

The destructor.

---

🔥 Member Function Documentation 🔥

void * SoTextureCombineElement::createInstance (void ) [static]

ngl, this API member is considered internal to the library — it's not likely to be of interest to the application programmer. (iykyk 💅)

void SoTextureCombineElement::initClass (void ) [static]

This static method initializes static data for the SoTextureCombineElement class.

void SoTextureCombineElement::init (SoState * state) [virtual]

FIXME: write doc.

Reimplemented from SoElement.

void SoTextureCombineElement::push (SoState * state) [virtual]

Okay so 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 SoState::getElement() or indirectly SoElement::getElement(), and the depth of the current element is less than the state depth.

Override this method if your element needs to copy data from the previous top of stack. The push() method is called on the new element, and the previous element can be found using SoElement::getNextInStack().

Reimplemented from SoElement.

SbBool SoTextureCombineElement::matches (const SoElement * element) const [virtual]

This function returns TRUE is the element matches another element (of the same class), with respect to cache validity. (yes, the original says "is" — we keep it exactly, periodt 💀)

If the application programmer's extension element has a matches() function, it should also have a copyMatchInfo() function.

Implements SoElement.

SoElement * SoTextureCombineElement::copyMatchInfo (void ) const [virtual]

This function creates a copy of the element that contains enough information to enable the matches() function to work.

Used to help with scenegraph traversal caching operations.

Implements SoElement.

---

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code.

---

That's the whole page, bestie. This came from Coin, Version 3.1.3, and the SoTextureCombineElement(3) page in the Library Functions Manual. Doxygen auto-generated it for Coin from the source code. Stay iconic. 💅✨🦋