SoShaderParameter3i(3)

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

🌸 SoShaderParameter3i(3) 🌸

okay bestie, welcome to the Coin manual, part 1 of 3, and no we are not done yet so don't you dare close the tab 💖

✨ NAME ✨

SoShaderParameter3i — the class that's literally here to define a three-dimensional integer value as a shader parameter. that's the whole job. she's a specialist, she's booked, she's thriving 🎀

like… that's it. that's her. a whole class whose entire main character energy is "i hold three ints and i hand them to a shader." iconic behavior, honestly 👑

and yes, SoShaderParameter3i is the class name, fr fr — you'll be typing it exactly like that, capitals and the 3i and everything, no cap 💅

lowkey the setup is giving "small but mighty," and we are only at the NAME section… there is SO much more coming 🦋

✨ SYNOPSIS ✨

okay so bestie, first things first, you gotta pull in the header:

#include <Inventor/nodes/SoShaderParameter.h>

and this icon Inherits SoUniformShaderParameter. periodt.

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const — the type-id getter, no cap.
  • virtual void updateParameter (SoGLShaderObject *shaderObject) — this one updates the shader parameter in the OpenGL state with the content of the value field. lowkey the whole point.

🌸 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.
  • 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 () — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. periodt.

✨ Static Public Member Functions inherited from SoUniformShaderParameter ✨

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

🎀 Public Attributes 🎀

  • SoSFVec3i32 value

💖 Public Attributes inherited from SoShaderParameter 💖

  • SoSFString name
  • SoSFInt32 identifier

🔒 Protected Member Functions 🔒

  • virtual const SoFieldData * getFieldData (void) const

🛡️ Protected Member Functions inherited from SoUniformShaderParameter 🛡️

  • SoGLShaderParameter * getGLShaderParameter (const uint32_t cachecontext)
  • void ensureParameter (SoGLShaderObject *shader)

🛡️ 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)

🧚 Static Protected Member Functions inherited from SoUniformShaderParameter 🧚

  • static const SoFieldData ** getFieldDataPtr (void)

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

🛡️ 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 💖

okay so the tea: the SoShaderParameter3i class is used to define a three-dimensional integer value as shader parameter. that's the whole vibe. periodt. 💅

🎀 MEMBER FUNCTION DOCUMENTATION 🎀

okay bestie, this is the part where we meet the actual functions. every single one. no skips, no cuts, we're doing the whole roster 💅

💫 SoType SoShaderParameter3i::getClassTypeId(void) — static

SoType SoShaderParameter3i::getClassTypeId(void)

this static cutie hands you back the SoType object that's associated with objects of this class. that's it, that's the whole job. class-level type info, served fresh ✨

🦋 SoType SoShaderParameter3i::getTypeId(void) const — virtual

SoType SoShaderParameter3i::getTypeId(void) const

gives you the type identification of an object derived from a class that inherits SoBase. this is the runtime-type-checking girlie — she's who you call for "downward" casting. know your type before you cast, periodt 🔥

Reimplemented from SoUniformShaderParameter.

🔒 const SoFieldData ** SoShaderParameter3i::getFieldDataPtr(void) — static, protected

const SoFieldData ** SoShaderParameter3i::getFieldDataPtr(void)

ngl bestie, this API member is considered internal to the library — it's not likely to be of interest to the application programmer. so like… if you're just out here writing scenes, this isn't your moment 🙈

it returns the SoFieldData class, which holds the information about fields in this node. 🗂️

🫶 const SoFieldData * SoShaderParameter3i::getFieldData(void) const — protected, virtual

const SoFieldData * SoShaderParameter3i::getFieldData(void) const

hands 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 SoUniformShaderParameter.

🌈 void SoShaderParameter3i::updateParameter(SoGLShaderObject * shaderObject) — virtual

void SoShaderParameter3i::updateParameter(SoGLShaderObject * shaderObject)

this is the main character move 👑 — it updates the shader parameter in the OpenGL state using the content of the value field. so whatever's sitting in value goes straight into the GL state. sync'd, slay'd, done 💅

Implements SoUniformShaderParameter.

🍓 MEMBER DATA DOCUMENTATION 🍓

⭐ SoSFVec3i32 SoShaderParameter3i::value

SoSFVec3i32 SoShaderParameter3i::value

the shader parameter value. that's the whole vibe — it's literally the value the parameter carries. three ints, one field, infinite possibilities 💜

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. yes, a robot wrote the docs, and honestly? it ate. 🤖✨

and that's a wrap on SoShaderParameter3i(3), bestie! this page came from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00. go forth and parameterize responsibly 🎀💖🦋

📦 where this page comes from