SoShaderProgram(3)

💖 SoShaderProgram(3) — Library Functions Manual 💖

okay so bestie, welcome to the SoShaderProgram page, part one of two, grab a boba 🧋 because she's a long one and she's iconic. 💅

---

✨ NAME ✨

SoShaderProgram — the class used to specify a set of vertex/geometry/fragment objects. 🎀

---

🌈 SYNOPSIS 🌈

#include <Inventor/nodes/SoShaderProgram.h>

Inherits SoNode. 💜

---

🫶 Public Member Functions

virtual SoType getTypeId (void) const
SoShaderProgram (void)
void setEnableCallback (SoShaderProgramEnableCB *cb, void *closure)
virtual void GLRender (SoGLRenderAction *action)
virtual void search (SoSearchAction *action)

💫 Public Member Functions inherited from SoNode

these are all inherited, she didn't write them herself, she just shows up with them 😌

void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=0) const
virtual SbBool affectsState (void) const
virtual void doAction (SoAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void write (SoWriteAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
uint32_t getNodeId (void) const
virtual SoChildList * getChildren (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool
    copyconnections)
virtual SoFieldContainer * copyThroughConnection (void) const

💫 Public Member Functions inherited from SoFieldContainer

void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool
    copyconnections=0)
SbBool set (const char *const fielddata)
void get (SbString &fielddata)
virtual int getFields (SoFieldList &l) const
virtual int getAllFields (SoFieldList &l) const
virtual SoField * getField (const SbName &name) const
virtual SoField * getEventIn (const SbName &name) const
virtual SoField * getEventOut (const SbName &name) const
SbBool getFieldName (const SoField *const field, SbName &name) const
SbBool enableNotify (const SbBool flag)
SbBool isNotifyEnabled (void) const
SbBool set (const char *fielddata, SoInput *in)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool getIsBuiltIn (void) const
void setUserData (void *userdata) const
void * getUserData (void) const

💫 Public Member Functions inherited from SoBase

void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
SbBool isOfType (SoType type) const
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorList & getAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (void) const

---

🌸 Static Public Member Functions

static SoType getClassTypeId (void)
static void initClass ()

💫 Static Public Member Functions inherited from SoNode

static uint32_t getCompatibilityTypes (const SoType &nodetype)
static SoType getClassTypeId (void)
static SoNode * getByName (const SbName &name)
static int getByName (const SbName &name, SoNodeList &l)
static void initClass (void)
static void initClasses (void)
static uint32_t getNextNodeId (void)
static int getActionMethodIndex (const SoType type)
static void getBoundingBoxS (SoAction *action, SoNode *node)
static void GLRenderS (SoAction *action, SoNode *node)
static void callbackS (SoAction *action, SoNode *node)
static void getMatrixS (SoAction *action, SoNode *node)
static void handleEventS (SoAction *action, SoNode *node)
static void pickS (SoAction *action, SoNode *node)
static void rayPickS (SoAction *action, SoNode *node)
static void searchS (SoAction *action, SoNode *node)
static void writeS (SoAction *action, SoNode *node)
static void audioRenderS (SoAction *action, SoNode *node)
static void getPrimitiveCountS (SoAction *action, SoNode *node)

💫 Static Public Member Functions inherited from SoFieldContainer

static void initClass (void)
static SoType getClassTypeId (void)
static void initCopyDict (void)
static void addCopy (const SoFieldContainer *orig, const
    SoFieldContainer *copy)
static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const
    SbBool copyconnections)
static void copyDone (void)

💫 Static Public Member Functions inherited from SoBase

static void initClass (void)
static SoType getClassTypeId (void)
static void addName (SoBase *const base, const char *const name)
static void removeName (SoBase *const base, const char *const name)
static void incrementCurrentWriteCounter (void)
static void decrementCurrentWriteCounter (void)
static SoBase * getNamedBase (const SbName &name, SoType type)
static int getNamedBases (const SbName &name, SoBaseList &baselist,
    SoType type)
static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *in, const SbName &fromnodename,
    const SbName &fromfieldname, const SbName &tonodename, const SbName
    &tofieldname)
static SbBool readRoute (SoInput *in)

---

🎀 Public Attributes

SoMFNode shaderObject

like. that's THE field bestie. the whole point. 👑

---

🔒 Protected Member Functions

virtual const SoFieldData * getFieldData (void) const
virtual ~SoShaderProgram ()

💫 Protected Member Functions inherited from SoNode

SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

💫 Protected Member Functions inherited from SoFieldContainer

SoFieldContainer (void)
~SoFieldContainer ()

💫 Protected Member Functions inherited from SoBase

SoBase (void)
virtual ~SoBase ()
virtual void destroy (void)
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine)
    const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const

---

🌟 Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

💫 Static Protected Member Functions inherited from SoNode

static const SoFieldData ** getFieldDataPtr (void)
static void setNextActionMethodIndex (int index)
static int getNextActionMethodIndex (void)
static void incNextActionMethodIndex (void)
static void setCompatibilityTypes (const SoType &nodetype, const
    uint32_t bitmask)

💫 Static Protected Member Functions inherited from SoBase

static uint32_t getCurrentWriteCounter (void)
static void staticDataLock (void)
static void staticDataUnlock (void)

---

🦋 Additional Inherited Members

💫 Public Types inherited from SoNode

the whole enum, every single bit, no cap:

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002,
    INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010,
    INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080,
    COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 =
    0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000
    }

💫 Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

💫 Protected Attributes inherited from SoNode

uint32_t uniqueId

💫 Protected Attributes inherited from SoFieldContainer

SbBool isBuiltIn

💫 Static Protected Attributes inherited from SoNode

static uint32_t nextUniqueId = 0
static int nextActionMethodIndex = 0

---

🫧 Detailed Description 🫧

so. SoShaderProgram is the class used to specify a set of vertex/geometry/fragment objects. that's literally her job description bestie. 💖

This node can store one of each of SoVertexShader, SoGeometryShader and SoFragmentShader in its shaderObject field. Coin will load all shader objects specified there, and attach all objects into a program before binding it as the current shader program. ✨ (the way she just… assembles the whole fit and then wears it. main character energy fr fr. 👑)

See Shaders in Coin for more information on how to set up a scene graph with shaders.

FILE FORMAT/DEFAULTS:

ShaderProgram {
  shaderObject []
}

👀 See also

• SoShaderObject
• SoShaderProgram

🗓️ Since

Coin 2.5

---

🔧 Constructor & Destructor Documentation 🔧

🎬 SoShaderProgram::SoShaderProgram (void )

Constructor. 💅

References shaderObject, and SoShaderProgram().

Referenced by getFieldData(), and SoShaderProgram().

💀 SoShaderProgram::~SoShaderProgram () [protected], [virtual]

Destructor. she's protected, she's virtual, she's leaving the function but never the group chat. 😭

---

okay bestie that's the whole first half and there is SO much more coming, don't go anywhere — part 2 is loading… 🦋

💖 Member Function Documentation 💖

SoType SoShaderProgram::getTypeId (void ) const [virtual]</p>

okay bestie so this one hands you back the type identification of literally any object that descends from SoBase — it's the whole ✨vibe check✨ of Coin's type system, used for run-time type checking and for "downward" casting. iykyk

Usage example, and yes we're keeping it character for character because it slays:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
  }
}

now for the application programmers out there who want to extend the library with new nodes, engines, nodekits, draggers or whatever else their heart desires 💅 — this method needs to be overridden in all subclasses. no skipping, no shortcuts, periodt. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through, for instance, Inventor/nodes/SoSubNode.h (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. macros do the heavy lifting, we love that for us 🧚

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. 👑

Implements SoBase.

---

const SoFieldData * SoShaderProgram::getFieldData (void ) const [protected], [virtual]</p>

this one gives you back a pointer to the class-wide field data storage object for this instance. and if there are no fields present? it returns NULL. simple as that bestie 🌸

Reimplemented from SoFieldContainer.

References SoShaderProgram().

---

void SoShaderProgram::setEnableCallback (SoShaderProgramEnableCB * cb, void * closure)</p>

this adds a callback which is called every time this program is enabled/disabled. like a little notification system that's obsessed with you 🔔✨

---

void SoShaderProgram::GLRender (SoGLRenderAction * action) [virtual]</p>

Action method for the SoGLRenderAction.

This gets called during rendering traversals. Nodes influencing the rendering state in any way — or who just wanna throw geometry primitives at OpenGL — override this method. main character energy fr fr 🌈

Reimplemented from SoNode.

---

void SoShaderProgram::search (SoSearchAction * action) [virtual]</p>

Action method for SoSearchAction.

It compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction — and if any of the requested criteria is a miss, the search is not deemed successful for the node. no partial credit, it's giving all-or-nothing 💀

See also

• SoSearchAction

Reimplemented from SoNode.

References SoAction::getPathCode(), SoSearchAction::isFound(), SoAction::popCurPath(), SoAction::pushCurPath(), SoNode::search(), shaderObject, and SoNode::SoNode().

---

🎀 Member Data Documentation 🎀

SoMFNode SoShaderProgram::shaderObject</p>

The shader objects. that's it, that's the whole description, and honestly? iconic 🫶

Referenced by search(), and SoShaderProgram().

---

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. 🤖💜

---

and that's a wrap bestie!! this page is from Coin, Version 2.5.0, filed under SoShaderProgram(3) — go forth and shade some shaders 💅🌸💖