SoShaderParameter(3)

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

🎀 SoShaderParameter(3) 🎀 — the Coin manual page, but make it cute

okay so bestie, welcome to SoShaderParameter, section 3 of the Coin manual. She's a base class, she's iconic, and she has an absurd number of inherited members. Buckle up. 💖

🌸 NAME 🌸

SoShaderParameter — the base class for all shader parameter classes.

That's literally it. She's the blueprint of blueprints, the mother of every shader parameter class out there. No cap. 👑

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoShaderParameter.h>
  • Inherits SoNode.
  • Inherited by SoUniformShaderParameter.

💜 Public Member Functions 💜

  • virtual SoType getTypeId (void) const

That's the only member function she brings to the function table herself, and honestly? She ate. Everything else she's got, she borrowed from her ancestors. Generational wealth fr fr. 💅

🌟 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

look at all those action methods. she really said "I contain multitudes". 🌈

🌟 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

field housekeeping, but make it fashion. 🎀

🌟 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

one lil note that came attached to isOfType: it Returns TRUE if the type of this object is either of the same type or inherited from type. periodt. 💅

⭐ Static Public Member Functions ⭐

  • 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)
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)

and for static void initClass (void) up there: 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 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 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 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)
  • 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.

🍓 Public Attributes 🍓

  • SoSFString name
  • SoSFInt32 identifier

two little public fields, just vibing out in the open. 💖

🦋 Protected Member Functions 🦋

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

🧚 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 }

that's a lot of enum values. she said "I contain every era of Inventor and Coin, actually." 🔥

🌸 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 SoShaderParameter class is the base class for all shader parameter classes.

In addition to the name and identifier field, all subclasses have a value field which is used for specifying the parameter value.

lowkey the whole family tree in two sentences. she's a base class, she's got a name, an identifier, and her kids all get a value too. that's the lore. 👑

💜 Constructor & Destructor Documentation 💜

SoShaderParameter::SoShaderParameter (void ) [protected]

Constructor.

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

Destructor.

and bestie… we are so not done. part 1 ends here but she has more to say. stay tuned 💅✨

💅 Member Function Documentation 💅

Okay bestie, we're in the member function era now. Buckle up. 🎀

SoType SoShaderParameter::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. It's giving "who dis?" but for types. iconic. ✨

SoType SoShaderParameter::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. very demure, very mindful. 🦋

Implements SoBase.

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

const SoFieldData ** SoShaderParameter::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. lowkey not for you bestie, but we don't gatekeep. 🙈

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

const SoFieldData * SoShaderParameter::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. no fields? no problem, just NULL energy. 💅

Reimplemented from SoFieldContainer.

Reimplemented in SoShaderParameter1f, SoShaderParameter1i, SoShaderParameter2f, SoShaderParameter2i, SoShaderParameter3f, SoShaderParameter3i, SoShaderParameter4f, SoShaderParameter4i, SoShaderParameterArray1f, SoShaderParameterArray1i, SoShaderParameterArray2f, SoShaderParameterArray2i, SoShaderParameterArray3f, SoShaderParameterArray3i, SoShaderParameterArray4f, SoShaderParameterArray4i, SoShaderParameterMatrix, SoShaderParameterMatrixArray, SoShaderStateMatrixParameter, and SoUniformShaderParameter. same list, same icons, we love consistency. 💖

🎀 Member Data Documentation 🎀

SoSFString SoShaderParameter::name

The shader parameter name. Used for Cg and GLSL programs. so like, the name tag of the shader parameter world. 🏷️

SoSFInt32 SoShaderParameter::identifier

The shader parameter identifier. Used for ARB shader programs. the ARB bestie's little ID card. 🪪

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. not a human, just a very efficient little robot. 🤖

And that's a wrap, bestie! Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and this whole page is SoShaderParameter(3). Go forth and slay your shader parameters. 💅✨🦋

📦 where this page comes from