SoShaderParameterArray2f(3)

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

💖 SoShaderParameterArray2f(3) — the Coin manual page, bestie edition 💖

okay so we're in the Coin manual, section 3, and today's main character is SoShaderParameterArray2f. Say it with me. Slay. 💅

✨ NAME ✨

SoShaderParameterArray2f — this class is literally here to define a two-dimensional floating point array as a shader parameter. that's the whole job. that's the vibe. 🦋

🎀 that's it for part 1, bestie — more is coming, don't go anywhere 🎀

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoShaderParameter.h>

and the family tree? bestie she Inherits from SoUniformShaderParameter 💅 so she's got that uniform-parameter bloodline, no cap.

🫶 Public Member Functions 🫶

  • virtual SoType getTypeId (void) const — hands you back the SoType for this thing, aka "who am I" but in type-system language.
  • virtual void updateParameter (SoGLShaderObject *shaderObject) — Updates the shader parameter in the OpenGL state with the content of the value field. this is literally her main character moment ✨ she takes whatever's chillin' in value and pushes it into the OpenGL state, periodt.

🌈 Public Member Functions inherited from SoNode 🌈

she didn't come alone, here's the whole entourage she inherited:

  • 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. so basically a bloodline check 👑 if it matches or descends from type, you get a TRUE.
  • 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. it's the lil' setup ritual every class goes through, no biggie 🌸

🌸 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. iykyk, it's the class's official ID card 🪪
  • 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 🍓

  • SoMFVec2f value — the actual goods, the 2D float array living right there in the open.

🌈 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 — and bestie, here's the whole menu of type flags, copied exactly so you don't gotta squint:
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 💖

The SoShaderParameterArray2f class is used to define a two-dimensional floating point array as shader parameter. that's it, that's the vibe 🌸 she's the one carrying a whole 2D float array into your shader like it's nothing.

💅 Member Function Documentation 💅

okay bestie, this is the part where we meet the actual functions, and honestly? they're giving very much "backstage crew making the magic happen." let's go one by one, no skipping, i promise 🫶

🦋 SoType SoShaderParameterArray2f::getClassTypeId (void ) [static]

this static method returns the SoType object associated with objects of this class. that's it, that's the whole job. it's the little class-ID badge everyone in this class gets to wear. ✨

🌸 SoType SoShaderParameterArray2f::getTypeId (void ) const [virtual]

this one hands you back the type identification of an object derived from a class inheriting SoBase. what's it for, you ask? runtime type checking and "downward" casting, bestie. it's the vibe check that lets the library go "oh, you're that kind of object, bet." 💅

Reimplemented from SoUniformShaderParameter.

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

okay so this one is internal to the library. like, the original literally says this API member is considered internal, as it is not likely to be of interest to the application programmer. so if you're just writing an app? not your business, boo. 🙈

what it does: returns the SoFieldData class which holds information about fields in this node. that's the tea.

🧚 const SoFieldData * SoShaderParameterArray2f::getFieldData (void ) const [protected], [virtual]

this one returns a pointer to the class-wide field data storage object for this instance. and here's the little plot twist: if there are no fields present, it returns NULL. so like, check before you dereference, mwah 💖

Reimplemented from SoUniformShaderParameter.

🔥 void SoShaderParameterArray2f::updateParameter (SoGLShaderObject * shaderObject) [virtual]

this is the main character moment fr. it updates the shader parameter in the OpenGL state with the content of the value field. so whatever you stuffed into value, this is the function that pushes it on over to the GL side. iconic behaviour, no notes. 👑

Implements SoUniformShaderParameter.

👑 Member Data Documentation 👑

🍓 SoMFVec2f SoShaderParameterArray2f::value

the shader parameter value. that's it. that's the data. the SoMFVec2f, the multi-field vec2 float, the whole point of the class, the reason we're all here. hold her gently 🥹

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. (not a human, not a bestie, just a doc generator doing its little robot thing 🤖💕)

and that's the whole page, babe — we made it to the end 🎉

this was Coin's docs for SoShaderParameterArray2f(3), Version 4.0.10, stamped Thu Jun 25 2026 00:00:00. go forth and slay your shader parameters, ily, bye 💜✨

📦 where this page comes from