SoUniformShaderParameter(3)

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

💖 SoUniformShaderParameter 💖

okay bestie, gather round, because we're doing SoUniformShaderParameter(3) — a Coin page — and it's a long one, so this is part 1 of 2. buckle up 🎀

🌸 NAME 🌸

SoUniformShaderParameter — the base class for all uniform shader variables. like, the mother of them all, the blueprint, the moment 💅

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoShaderParameter.h>

Inherits SoShaderParameter.

Inherited by SoShaderParameter1f, SoShaderParameter1i,
SoShaderParameter2f, SoShaderParameter2i, SoShaderParameter3f,
SoShaderParameter3i, SoShaderParameter4f, SoShaderParameter4i,
SoShaderParameterArray1f, SoShaderParameterArray1i,
SoShaderParameterArray2f, SoShaderParameterArray2i,
SoShaderParameterArray3f, SoShaderParameterArray3i,
SoShaderParameterArray4f, SoShaderParameterArray4i,
SoShaderParameterMatrix, SoShaderParameterMatrixArray, and
SoShaderStateMatrixParameter.

so she inherits from SoShaderParameter, and she's the parent of that whole giant list of children above. a whole dynasty fr fr 👑

🫶 Public Member Functions 🫶

  • virtual SoType getTypeId (void) const — grab the SoType for this thing, the way you'd check someone's star sign but for classes ✨
  • virtual void updateParameter (SoGLShaderObject *shaderObject)=0 — updates the shader parameter in the OpenGL state with the content of the value field. note the =0 bestie, this one is pure virtual, meaning the base class says "you handle it" and every subclass has to show up and do the work 😤

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 GLRender (SoGLRenderAction *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 search (SoSearchAction *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. (iykyk, it's the "are we family" 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) — the static version of the type lookup, no instance required 🦋
  • 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. (the "warm up the class" ritual ✨)

Static Public Member Functions inherited from SoShaderParameter

  • static SoType getClassTypeId (void)
  • static void initClass () — 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)

🧚 Protected Member Functions 🧚

  • virtual const SoFieldData * getFieldData (void) const — internal field-table access, protected so only the family gets in 🙈
  • SoGLShaderParameter * getGLShaderParameter (const uint32_t cachecontext) — hands you the GL-side parameter object for a given cachecontext
  • void ensureParameter (SoGLShaderObject *shader) — makes sure the parameter actually exists for this shader, no cap

Protected Member Functions inherited from SoShaderParameter

  • SoShaderParameter ()
  • virtual ~SoShaderParameter ()

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)
  • 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) — pointer to the pointer to the field data. yes it's a double pointer, she's fancy 💅

Static Protected Member Functions inherited from SoShaderParameter

  • 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

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 SoShaderParameter

  • SoSFString name
  • SoSFInt32 identifier

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 the synopsis fully unpacked bestie 🍓 like I said, she's long, and there's still more page to go — so don't go anywhere, because the rest is coming up next 💖

💖 DETAILED DESCRIPTION 💖

okay so bestie, here's the tea ☕ — SoUniformShaderParameter is the base class for all uniform shader variables. Like, every single one of them is its descendant. main character energy fr fr 👑

and what are uniform shader variables for, you ask? they're the lil messengers that carry parameters from the scene graph over to the shader program. passing notes in class, but make it GPU ✨

so in the shader program itself, the variable gets declared like this:

uniform float shininess;
that's literally it. that's the whole declaration. gorgeous. no notes 💅

and if you wanna go deeper, See Shaders in Coin for more information. 🦋

✨ MEMBER FUNCTION DOCUMENTATION ✨

SoType SoUniformShaderParameter::getClassTypeId (void ) [static]

this static method hands you back the SoType object that's associated with objects of this class. your lil class ID badge 🎀

SoType SoUniformShaderParameter::getTypeId (void ) const [virtual]

returns the type identification of an object derived from a class that inherits SoBase. what's it for? runtime type checking and "downward" casting, bestie. it's how the library figures out what it's actually looking at before it goes casting 💅

Reimplemented from SoShaderParameter.

Reimplemented in SoShaderParameter1f, SoShaderParameter1i, SoShaderParameter2f, SoShaderParameter2i, SoShaderParameter3f, SoShaderParameter3i, SoShaderParameter4f, SoShaderParameter4i, SoShaderParameterArray1f, SoShaderParameterArray1i, SoShaderParameterArray2f, SoShaderParameterArray2i, SoShaderParameterArray3f, SoShaderParameterArray3i, SoShaderParameterArray4f, SoShaderParameterArray4i, SoShaderParameterMatrix, SoShaderParameterMatrixArray, and SoShaderStateMatrixParameter.

look at that list 😭 it's giving entire friend group.

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

okay so heads up: this API member is considered internal to the library, because it's not likely to be of interest to the application programmer. so like… if you're just vibing and writing an app, this one probably isn't for you 🙈

it returns the SoFieldData class which holds information about fields in this node. ✨

const SoFieldData * SoUniformShaderParameter::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. empty-handed, bestie. nothing. zero. nada 💀

Reimplemented from SoShaderParameter.

Reimplemented in SoShaderParameter1f, SoShaderParameter1i, SoShaderParameter2f, SoShaderParameter2i, SoShaderParameter3f, SoShaderParameter3i, SoShaderParameter4f, SoShaderParameter4i, SoShaderParameterArray1f, SoShaderParameterArray1i, SoShaderParameterArray2f, SoShaderParameterArray2i, SoShaderParameterArray3f, SoShaderParameterArray3i, SoShaderParameterArray4f, SoShaderParameterArray4i, SoShaderParameterMatrix, SoShaderParameterMatrixArray, and SoShaderStateMatrixParameter.

same iconic lineup, we love consistency 🌈

virtual void SoUniformShaderParameter::updateParameter (SoGLShaderObject * shaderObject) [pure virtual]

this one updates the shader parameter in the OpenGL state using the content of the value field. 🫶

and it's pure virtual, which means — bestie, listen — there is no implementation here. you literally cannot just call it on this class. it's a promise the subclasses have to keep themselves. periodt 💅

Implemented in SoShaderParameter1f, SoShaderParameter1i, SoShaderParameter2f, SoShaderParameter2i, SoShaderParameter3f, SoShaderParameter3i, SoShaderParameter4f, SoShaderParameter4i, SoShaderParameterArray1f, SoShaderParameterArray1i, SoShaderParameterArray2f, SoShaderParameterArray2i, SoShaderParameterArray3f, SoShaderParameterArray3i, SoShaderParameterArray4f, SoShaderParameterArray4i, SoShaderParameterMatrix, SoShaderParameterMatrixArray, and SoShaderStateMatrixParameter.

not a single one of them skipped the assignment 😤 ate and left no crumbs.

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code.

(yes bestie, a robot wrote this page. and it slayed. we love a machine that does its homework 🤖✨)

and that's a wrap on part 2, my love 🎀 this whole thing came from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00 — so go forth, declare your uniforms, pass those parameters, and stay iconic. mwah 💖🦋💅

📦 where this page comes from