SoFragmentShader(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

🦋 SoFragmentShader(3) — the Coin fragment-shader baddie 💅

okay so welcome to SoFragmentShader(3), bestie. this is the Coin manual page and it's literally all about the class you use for setting up fragment shader programs. grab a snack, it's a long one, and we're doing it in two parts. 🍓

🌸 NAME 🌸

SoFragmentShader — the class that's used for setting up fragment shader programs. that's the whole job. she's focused, she's iconic. 👑

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoFragmentShader.h>

Inherits SoShaderObject.

so like. she's a shader object. she inherited the whole glow from SoShaderObject and she's not shy about it. 💜

🫶 Public Member Functions

  • 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 render (SoState *state)
  • 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)
  • SbUniqueId 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 — gives you back TRUE if the type of this object is either the same type, or inherited from type. basically a lil identity check. 💅
  • 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) — sets up the initialization for the data that's common to all instances of this class, like submitting the necessary information to the Coin type system. it's the "get everyone on the same page" moment. 🫶
  • static SbBool isSupported (SourceType sourceType)

🌸 Static Public Member Functions inherited from SoShaderObject

  • static SoType getClassTypeId (void)
  • static void initClass (void) — sets up the initialization for the data common to all instances of this class, like submitting the necessary information to the Coin type system.

🦋 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) — sets up the initialization for the data common to all instances of this class, like submitting the necessary information to the Coin type system.
  • static void initClasses (void)
  • static SbUniqueId 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) — sets up the initialization for the data common to all instances of this class, like submitting the necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class. it's giving "who am I" energy. 💜
  • 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) — sets up the initialization for the data common to all instances of this class, like submitting the necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • 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
  • virtual SoNotRec createNotRec (void)

🌸 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, COIN_4_0 = 0x20000 }

🎀 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

  • SbUniqueId uniqueId

💖 Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

⭐ Static Protected Attributes inherited from SoNode

static SbUniqueId nextUniqueId = 1
static int nextActionMethodIndex = 0

and that's where part 1 leaves us, bestie — don't go anywhere, there's more coming. 🫶✨

✨ DETAILED DESCRIPTION ✨

okay so bestie, the SoFragmentShader class is literally the glow-up for your fragment shader programs 💅 it's the whole vibe for setting up fragment shader programs, periodt.

See Shaders in Coin for more information on how to set up a scene graph with shaders. (iykyk — go read that one too, it's giving essential.)

🎀 FILE FORMAT/DEFAULTS 🎀

this is the default fit it shows up in, no cap:

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

🌸 SEE ALSO 🌸

  • SoShaderObject
  • SoShaderProgram

🦋 SINCE 🦋

Coin 2.5 — she's been iconic since day one, fr fr.

💖 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 💖

🌈 SoFragmentShader::SoFragmentShader (void )

Constructor. the birth of a legend, honestly 🫶

🌈 SoFragmentShader::~SoFragmentShader () [virtual]

Destructor. she's leaving the group chat 😭 but her legacy lives on.

👑 MEMBER FUNCTION DOCUMENTATION 👑

⭐ SoType SoFragmentShader::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. it's the "who even am I" but make it ✨official✨.

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. basically the ID check at the door 🚪 — you gotta prove you're the right type before you get in.

Reimplemented from SoShaderObject.

⭐ const SoFieldData ** SoFragmentShader::getFieldDataPtr (void ) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. (translation: not for you bestie, this is backstage energy 🙈)

Returns the SoFieldData class which holds information about fields in this node.

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

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. like, zero, zilch, nada — don't come for her.

Reimplemented from SoShaderObject.

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

Returns a boolean indicating whether the requested source type is supported by the OpenGL driver or not. yes or no, no in-between 💀

⚠️ Beware: To get a correct answer, a valid OpenGL context must be available. no context, no truth — she will not be gaslit, she will simply not answer correctly. 🙈

🫶 AUTHOR 🫶

Generated automatically by Doxygen for Coin from the source code. (the robots wrote this one, and honestly? they ate. 🤖✨)

and that's a wrap on part 2, bestie 💜 this page is Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's the SoFragmentShader(3) manual page — go set up some shaders and slay, no cap 🎀🦋🌸

📦 where this page comes from