SoShaderObject(3)

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

💖 NAME 💖

SoShaderObject(3) — bestie, this is the superclass for all shader classes in Coin. It's the main character that lets all the shader babies do their thing. 👑

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoShaderObject.h>

Inherits SoNode.

Inherited by SoFragmentShader, SoGeometryShader, and SoVertexShader.

🌸 Public Types 🌸

  • 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 Member Functions 💅

  • virtual SoType getTypeId (void) const
  • 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 — Returns TRUE if the type of this object is either of the same type or inherited from type.
  • 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 initialization for data common to all instances of this class, like submitting 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 initialization for data common to all instances of this class, like submitting 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 initialization for data common to all instances of this class, like submitting 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 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 initialization for data common to all instances of this class, like submitting 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)

🎀 Public Attributes 🎀

  • SoSFBool isActive
  • SoSFEnum sourceType
  • SoSFString sourceProgram
  • SoMFNode parameter

🛡️ Protected Member Functions 🛡️

  • virtual const SoFieldData * getFieldData (void) const
  • 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 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 🌈

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

🔥 Detailed Description 🔥

The SoShaderObject class is the superclass for all shader classes in Coin. It's giving founding mother of shaders, and we stan. 👑

See Shaders in Coin for more information on how to set up a scene graph with shaders. Bestie, that's the lore you need. 📖✨

See also SoShaderProgram — the other half of the shader duo. 🫶

🌸 Member Enumeration Documentation 🌸

enum SoShaderObject::SourceType

Used for enumerating the shader types in sourceProgram. It's the vibe check for what kind of shader you're dealing with. 💅

Enumerator

  • ARB_PROGRAM — Specifies an ARB shader.
  • CG_PROGRAM — Specifies a Cg shader program.
  • GLSL_PROGRAM — Specifies a GLSL program.
  • FILENAME — Shader should be loaded from the file in sourceProgram.

🎀 Constructor & Destructor Documentation 🎀

SoShaderObject::SoShaderObject (void ) [protected]

Constructor. It's the birth of a shader object, lowkey iconic. 🍼✨

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

Destructor. It's the farewell tour, but make it virtual. 💀👋

okay part 1 done, part 2 loading… don't go anywhere bestie 💖

🌸 Member Function Documentation 🌸

okay bestie, this is the part where we get into the actual methods — the moves you can pull 💅 every single one is here, no skips, no cap.

SoType SoShaderObject::getClassTypeId (void ) — [static]

This one's a static method, and what it does is hand you back the SoType object that's associated with objects of this class. That's it. That's the whole job. Iconic minimalism ✨

SoType SoShaderObject::getTypeId (void ) const — [virtual]

Returns the type identification of an object derived from a class that inherits SoBase. What's it for, you ask? runtime type checking and "downward" casting. That's the vibe. 🦋

  • Implements SoBase.
  • Reimplemented in SoFragmentShader, SoGeometryShader, and SoVertexShader.

const SoFieldData ** SoShaderObject::getFieldDataPtr (void ) — [static], [protected]

heads up bestie: this API member is considered internal to the library, because it's not likely to be of any interest to the application programmer. so like… you can look, but it's giving backstage-pass-only 🫣

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

const SoFieldData * SoShaderObject::getFieldData (void ) const — [protected], [virtual]

Gives you a pointer to the class-wide field data storage object for this particular instance. And if there are no fields present? It returns NULL. Simple as that. 💀

  • Reimplemented from SoFieldContainer.
  • Reimplemented in SoFragmentShader, SoGeometryShader, and SoVertexShader.

void SoShaderObject::GLRender (SoGLRenderAction * action) — [virtual]

This is the action method for the SoGLRenderAction. It gets called during rendering traversals 🌈

So like — any node that influences the rendering state in any way, or that wants to throw geometry primitives at OpenGL, overrides this method. That's the whole point of it.

  • Reimplemented from SoNode.
  • Reimplemented in SoGeometryShader.

void SoShaderObject::search (SoSearchAction * action) — [virtual]

The action method for SoSearchAction.

What happens here is it compares the search criteria from the action to figure out whether this node is a match. 🔍 The searching itself is done by matching up all the criteria set up in the SoSearchAction — and listen, if any one of the requested criteria is a miss, then the search is not deemed successful for the node. All-or-nothing, main character energy, periodt. 👑

See also: SoSearchAction
  • Reimplemented from SoNode.

void SoShaderObject::updateParameters (SoState * state)

Used internally to update shader parameters. That's the whole description, bestie — it's an inside-job method. 🙈

SoShaderObject::SourceType SoShaderObject::getSourceType (void ) const

Returns the shader type that was detected in the source program. ✨

SbString SoShaderObject::getSourceProgram (void ) const

Returns the actual shader program. Like, the real one. The source itself. 🎀

SbBool SoShaderObject::readInstance (SoInput * in, unsigned short flags) — [protected], [virtual]

This method is mainly intended for internal use during file import operations, so don't come for it unless you're doing some deep file-format business. 🧚

Here's the deal: it reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistent representation of an instance of this class type.

TRUE or FALSE gets returned, depending on whether the instantiation and configuration of the new object of this class type went OK or not. And real talk — the import process should be robust and handle corrupted input streams by returning FALSE. No crashing, we're classy. 💅

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

  • Reimplemented from SoNode.

🎀 Member Data Documentation 🎀

the fields!! the actual knobs you get to turn 🎛️✨

  • SoSFBool SoShaderObject::isActive — enabled/disables the shader. Default value is TRUE. 🟢
  • SoSFEnum SoShaderObject::sourceType — the type of shader. That's it, that's the field. 🌈
  • SoSFString SoShaderObject::sourceProgram — the shader program, or a file name if the shader should be loaded from a file. And if the shader is loaded from a file, then the shader type is identified by the file extension:
    • .glsl for GLSL shaders
    • .cg for Cg shaders
    • .vp and .fp for ARB shaders

so yes bestie, the extension is doing a LOT of heavy lifting here. iykyk 🦋

  • SoMFNode SoShaderObject::parameter — the shader program parameters. ⭐

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

and that's the page, bestie!! 🫶 written by robots (Doxygen, specifically, for Coin) but explained with love.

Version 4.0.10 — dated Thu Jun 25 2026 00:00:00 — filed under SoShaderObject(3) 💖 slay, go write some shaders ✨

📦 where this page comes from