SoShaderParameter2f(3)

πŸ“¦
version 4.0.10 Β· 4 versions
, in fedora 43, fedora 44

πŸ’– SoShaderParameter2f β€” from the Coin manual, section 3 πŸ’–

okay bestie, welcome to SoShaderParameter2f(3) ✨ this is the page for the SoShaderParameter2f class, and she is serving one very specific purpose πŸ’…


✨ NAME ✨

SoShaderParameter2f β€” the class you reach for when you wanna define a two-dimensional floating point value as a shader parameter πŸŽ€

like. that's it. that's her whole thing. two floats, side by side, living their best life as a shader parameter πŸ¦‹ ngl it's giving "small but essential" and we love that for her 😌


no cap, this is only part 1 of the page β€” more is coming, so don't go anywhere πŸ’–

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoShaderParameter.h>

Inherits SoUniformShaderParameter. So yeah, everything that parent class brings to the table? She's got it too, no cap. 🫢


πŸ’– Public Member Functions πŸ’–

  • virtual SoType getTypeId (void) const β€” the classic "who even am I" type-identity method. πŸ‘‘
  • virtual void updateParameter (SoGLShaderObject *shaderObject) β€” bestie this is the main character move: it updates the shader parameter in the OpenGL state using whatever's sitting in the value field. That's literally her whole job. ✨

🌸 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

That's the whole roster, okay, I didn't skip a single one. πŸ’…

πŸ¦‹ 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. She's doing the paperwork so you don't have to, queen. πŸ“

⭐ 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. Same ritual, different class. ✨

🌈 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. Yeah bestie, they all do it, it's a whole family tradition. 🫢

πŸ’œ 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 πŸ’…

  • SoSFVec2f value β€” this is the two floats, bestie. The whole point of her existence. 🎯

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

Look at that bitmask lineup, it's giving legacy support realness. πŸ’€

πŸ’œ 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 SoShaderParameter2f class is used to define a two-dimensional floating point value as shader parameter. That's it, that's her whole vibe β€” two floats, one value field, zero drama. πŸ’…βœ¨

✨ Member Function Documentation ✨

okay bestie, this is the part where we meet the actual functions. grab a boba, we're going in πŸ§‹


πŸ¦‹ SoType SoShaderParameter2f::getClassTypeId (void) β€” [static]

static method, no instance needed, she does not need you to show up with an object. she just hands you the SoType object that's associated with objects of this class. that's it. that's the whole vibe. ✨


πŸ”₯ SoType SoShaderParameter2f::getTypeId (void) const β€” [virtual]

this one gives you back the type identification of an object that's derived from a class inheriting SoBase. what's it for, you ask? runtime type checking and "downward" casting. literally the whole personality is "who am I and can you cast me down". iconic behavior tbh πŸ‘‘

reimplemented from SoUniformShaderParameter β€” so yeah, she's over here doing her own version of a thing her parent class already had. main character energy.

πŸ’œ const SoFieldData ** SoShaderParameter2f::getFieldDataPtr (void) β€” [static], [protected]

ngl bestie, this one is internal to the library. like, the manpage itself says it "is not likely to be of interest to the application programmer". so if you're just out here writing app code? this is not your moment. move along, gorgeous πŸ’…

but for the record, since we keep every detail around here: it returns the SoFieldData class which holds information about fields in this node.


πŸŽ€ const SoFieldData * SoShaderParameter2f::getFieldData (void) const β€” [protected], [virtual]

this one returns a pointer to the class-wide field data storage object for this instance. and listen β€” if there are no fields present, it returns NULL. not empty, not vibes, NULL. so check before you dereference, okay?? 😭

reimplemented from SoUniformShaderParameter (yes, again, she's customizing)

🌸 void SoShaderParameter2f::updateParameter (SoGLShaderObject *shaderObject) β€” [virtual]

the moment we've all been waiting for 🫢 this one updates the shader parameter in the OpenGL state using the content of the value field. so like, whatever you put in value? that's what goes into the GL state. she's the bridge between your little field and the actual graphics pipeline. ate, honestly.

implements SoUniformShaderParameter

πŸ“ Member Data Documentation πŸ“

⭐ SoSFVec2f SoShaderParameter2f::value

the shader parameter value. that's literally the entire description, no notes, she's straightforward like that. it's an SoSFVec2f, so it's a vec2f, and it is the value. periodt πŸ’–


πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for Coin from the source code. so like, no human author to thank, just the machine doing her thing, we love an automated queen πŸ€–βœ¨


and that's a wrap on SoShaderParameter2f(3) bestie!! this page is from Coin version 4.0.10, and the date on it is Thu Jun 25 2026 00:00:00. go forth and set your vec2f values, you've got this πŸ’–πŸ¦‹πŸŒˆ
πŸ“¦ where this page comes from