SoFragmentShader(3)

💖 SoFragmentShader(3) 💖

okay bestie, gather round, because today we're talking about SoFragmentShader — the class that sets up fragment shader programs. it lives in the SoFragmentShader bit of your library functions, and honestly? it's giving main character energy for your GPU. let's get into it. 🫶

---

🌸 NAME

SoFragmentShader — the class that's used for setting up fragment shader programs. periodt.

---

✨ SYNOPSIS

first things first, you gotta let it in:

#include <Inventor/nodes/SoFragmentShader.h>

it Inherits SoShaderObject. so like, it's part of that family, iykyk. 🧚

💫 Public Member Functions

these are the ones it calls its own:

virtual SoType getTypeId (void) const
SoFragmentShader (void)
virtual ~SoFragmentShader ()

💫 Public Member Functions inherited from SoShaderObject

virtual void GLRender (SoGLRenderAction *action)
virtual void search (SoSearchAction *action)
void updateParameters (SoState *state)
SourceType getSourceType (void) const
SbString getSourceProgram (void) const

💫 Public Member Functions inherited from SoNode

void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=FALSE) 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=FALSE)
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 *input)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool getIsBuiltIn (void) const
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) 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 (void)
static SbBool isSupported (SourceType sourceType)

⭐ Static Public Member Functions inherited from SoShaderObject

static SoType getClassTypeId (void)
static void initClass (void)

⭐ 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 cleanupClass (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 *input, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
static SbBool readRoute (SoInput *input)

🛡️ Protected Member Functions

virtual const SoFieldData * getFieldData (void) const

🛡️ Protected Member Functions inherited from SoShaderObject

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

🛡️ Protected Member Functions inherited from SoNode

SoNode (void)
virtual ~SoNode ()

🛡️ Protected Member Functions inherited from SoFieldContainer

SoFieldContainer (void)
virtual ~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 SoShaderObject

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 SoShaderObject:

enum SourceType { ARB_PROGRAM, CG_PROGRAM, GLSL_PROGRAM, FILENAME }

Public Types inherited from SoNode:

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, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

Public Attributes inherited from SoShaderObject:

SoSFBool isActive
SoSFEnum sourceType
SoSFString sourceProgram
SoMFNode parameter

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 = 1
static int nextActionMethodIndex = 0

---

🦋 Detailed Description

so, real talk: the SoFragmentShader class is used for setting up fragment shader programs. that's the whole vibe. 💅

for the full tea on how to set up a scene graph with shaders, go read Shaders in Coin.

and here's the FILE FORMAT/DEFAULTS, copy it exactly bestie, no cap:

FragmentShader {
  isActive TRUE
  sourceType FILENAME
  sourceProgram ""
  parameter []
}

👀 See also

• SoShaderObject
• SoShaderProgram

⏳ Since

Coin 2.5 — so it's been iconic for a minute. 👑

---

🎀 Constructor & Destructor Documentation

🌟 SoFragmentShader::SoFragmentShader (void )

Constructor. it makes the thing. ✨

💀 SoFragmentShader::~SoFragmentShader () [virtual]

Destructor. it unmakes the thing. rest in peace, shader object. 🫶

💖 Member Function Documentation 💖

---

🌟 SoType SoFragmentShader::getTypeId (void ) const [virtual]

Okay so bestie, this one returns the type identification of an object that derives from SoBase. What's it for? Run-time type checking and "downward" casting, periodt. 👑

Usage example, and yes you're gonna want to actually read this one:

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

Now, for the application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. That's the vibe. It's typically done as part of setting up the full type system for extension classes, and the way you usually pull that off is 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 — plus Inventor/engines/SoSubEngine.h (for engine classes) and so on. 🧚

Want more deets on writing Coin extensions? Go look at the class documentation of the toplevel superclasses for the various class groups. That's where the lore lives. ✨

Reimplemented from SoShaderObject.

---

🦋 const SoFieldData * SoFragmentShader::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. And if there are no fields present? It returns NULL. That's it, that's the whole thing. 💅

Reimplemented from SoShaderObject.

---

🔥 SbBool SoFragmentShader::isSupported (SourceType sourceType) [static]

Returns a boolean telling you whether the requested source type is supported by the OpenGL driver or not. Simple as that. 🌈

⚠️ Beware bestie: to get a correct answer, a valid OpenGL context must be available. No context, no truth. It's giving "can't do a vibe check without the vibe." 😭

---

🎀 Author

Generated automatically by Doxygen for Coin from the source code. Not a human, just a very diligent little robot doing its thing. 🤖💖

---

And that's a wrap on SoFragmentShader(3), my love! 🫶 This iconic little doc came from Coin, Version 3.1.3, and it's your girl SoFragmentShader(3) signing off. Go forth and cast safely. ⭐👑