SoShaderParameter1i(3)

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

✨ SoShaderParameter1i ✨

okay so bestie, welcome to the Coin manual, and today's main character is SoShaderParameter1i πŸ’…


πŸ’– NAME πŸ’–

SoShaderParameter1i β€” the class you use to define an integer value as a shader parameter πŸŽ€

ngl, that's the whole vibe: it's giving "one integer, going straight into your shader." no cap. πŸ¦‹


✨ SYNOPSIS ✨

okay bestie, here's how you pull this bad boy in β€” one header, no drama:

#include <Inventor/nodes/SoShaderParameter.h>

Inherits SoUniformShaderParameter. that's the lineage, and honestly it's giving royal family πŸ’…


πŸ‘‘ Public Member Functions

  • virtual SoType getTypeId (void) const β€” the type-checking flex, inherited from the ancestors (no extra description given, it just is).
  • virtual void updateParameter (SoGLShaderObject *shaderObject) β€” Updates the shader parameter in the OpenGL state with the content of the value field. literally the whole point of this class existing, no cap ✨

πŸ¦‹ Public Member Functions inherited from SoNode

not me listing every single one, because bestie, we do NOT skip:

  • void setOverride (const SbBool state) β€” inherited, signature's the whole story πŸŽ€
  • SbBool isOverride (void) const β€” inherited, no notes πŸ’œ
  • void setNodeType (const NodeType type) β€” inherited ✨
  • NodeType getNodeType (void) const β€” inherited ✨
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const β€” inherited, and yes, copyconnections defaults to FALSE 🌸
  • virtual SbBool affectsState (void) const β€” inherited πŸ’…
  • virtual void doAction (SoAction *action) β€” inherited πŸ¦‹
  • virtual void GLRender (SoGLRenderAction *action) β€” inherited πŸ¦‹
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) β€” inherited πŸ¦‹
  • virtual void GLRenderInPath (SoGLRenderAction *action) β€” inherited πŸ¦‹
  • virtual void GLRenderOffPath (SoGLRenderAction *action) β€” inherited πŸ¦‹
  • virtual void callback (SoCallbackAction *action) β€” inherited πŸ“
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) β€” inherited πŸ“
  • virtual void getMatrix (SoGetMatrixAction *action) β€” inherited πŸ“
  • virtual void handleEvent (SoHandleEventAction *action) β€” inherited πŸ“
  • virtual void pick (SoPickAction *action) β€” inherited πŸ“
  • virtual void rayPick (SoRayPickAction *action) β€” inherited πŸ“
  • virtual void search (SoSearchAction *action) β€” inherited πŸ“
  • virtual void write (SoWriteAction *action) β€” inherited πŸ“
  • virtual void audioRender (SoAudioRenderAction *action) β€” inherited 🎧
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) β€” inherited 🎧
  • virtual void grabEventsSetup (void) β€” inherited πŸ’€
  • virtual void grabEventsCleanup (void) β€” inherited πŸ’€
  • virtual void startNotify (void) β€” inherited πŸ’€
  • virtual void notify (SoNotList *l) β€” inherited πŸ’€
  • SbUniqueId getNodeId (void) const β€” inherited ⭐
  • virtual SoChildList * getChildren (void) const β€” inherited ⭐
  • virtual void writeInstance (SoOutput *out) β€” inherited ⭐
  • virtual SoNode * addToCopyDict (void) const β€” inherited ⭐
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) β€” inherited ⭐
  • virtual SoFieldContainer * copyThroughConnection (void) const β€” inherited ⭐

πŸ’– Public Member Functions inherited from SoFieldContainer

  • void setToDefaults (void) β€” inherited, no deets given 🫢
  • SbBool hasDefaultValues (void) const β€” inherited 🫢
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const β€” inherited 🫢
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) β€” inherited, copyconnections defaults to FALSE 🫢
  • SbBool set (const char *const fielddata) β€” inherited 🌈
  • void get (SbString &fielddata) β€” inherited 🌈
  • virtual int getFields (SoFieldList &l) const β€” inherited 🌈
  • virtual int getAllFields (SoFieldList &l) const β€” inherited 🌈
  • virtual SoField * getField (const SbName &name) const β€” inherited 🌈
  • virtual SoField * getEventIn (const SbName &name) const β€” inherited 🌈
  • virtual SoField * getEventOut (const SbName &name) const β€” inherited 🌈
  • SbBool getFieldName (const SoField *const field, SbName &name) const β€” inherited 🧚
  • SbBool enableNotify (const SbBool flag) β€” inherited 🧚
  • SbBool isNotifyEnabled (void) const β€” inherited 🧚
  • SbBool set (const char *fielddata, SoInput *input) β€” inherited 🧚
  • void get (SbString &fielddata, SoOutput *out) β€” inherited 🧚
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) β€” inherited 🧚
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) β€” inherited, isfromfield defaults to FALSE 🧚
  • SbBool getIsBuiltIn (void) const β€” inherited 🧚
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const β€” inherited 🧚
  • void setUserData (void *userdata) const β€” inherited 🧚
  • void * getUserData (void) const β€” inherited 🧚

πŸŽ€ Public Member Functions inherited from SoBase

  • void ref (void) const β€” inherited, no notes πŸ’œ
  • void unref (void) const β€” inherited πŸ’œ
  • void unrefNoDelete (void) const β€” inherited πŸ’œ
  • int32_t getRefCount (void) const β€” inherited πŸ’œ
  • void touch (void) β€” inherited πŸ’œ
  • SbBool isOfType (SoType type) const β€” Returns TRUE if the type of this object is either of the same type or inherited from type. okay that one actually has lore πŸ“–
  • virtual SbName getName (void) const β€” inherited 🌸
  • virtual void setName (const SbName &newname) β€” inherited 🌸
  • void addAuditor (void *const auditor, const SoNotRec::Type type) β€” inherited 🌸
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) β€” inherited 🌸
  • const SoAuditorList & getAuditors (void) const β€” inherited 🌸
  • SbBool shouldWrite (void) β€” inherited 🌸
  • void assertAlive (void) const β€” inherited 🌸

🌟 Static Public Member Functions

  • static SoType getClassTypeId (void) β€” inherited, no description attached πŸŽ€
  • static void initClass () β€” Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. that's the one that actually does the setting-up, bestie ✨

πŸ’« Static Public Member Functions inherited from SoUniformShaderParameter

  • static SoType getClassTypeId (void) β€” inherited πŸ¦‹
  • 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) β€” inherited πŸ“
  • 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) β€” inherited ⭐
  • static SoType getClassTypeId (void) β€” inherited ⭐
  • static SoNode * getByName (const SbName &name) β€” inherited ⭐
  • static int getByName (const SbName &name, SoNodeList &l) β€” inherited ⭐
  • 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) β€” inherited ⭐
  • static SbUniqueId getNextNodeId (void) β€” inherited ⭐
  • static int getActionMethodIndex (const SoType type) β€” inherited ⭐
  • static void getBoundingBoxS (SoAction *action, SoNode *node) β€” inherited ⭐
  • static void GLRenderS (SoAction *action, SoNode *node) β€” inherited ⭐
  • static void callbackS (SoAction *action, SoNode *node) β€” inherited ⭐
  • static void getMatrixS (SoAction *action, SoNode *node) β€” inherited ⭐
  • static void handleEventS (SoAction *action, SoNode *node) β€” inherited ⭐
  • static void pickS (SoAction *action, SoNode *node) β€” inherited ⭐
  • static void rayPickS (SoAction *action, SoNode *node) β€” inherited ⭐
  • static void searchS (SoAction *action, SoNode *node) β€” inherited ⭐
  • static void writeS (SoAction *action, SoNode *node) β€” inherited ⭐
  • static void audioRenderS (SoAction *action, SoNode *node) β€” inherited ⭐
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) β€” inherited ⭐

πŸ’« 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) β€” inherited 🌈
  • static void initCopyDict (void) β€” inherited 🌈
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) β€” inherited 🌈
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) β€” inherited 🌈
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) β€” inherited 🌈
  • static void copyDone (void) β€” inherited 🌈

πŸ’« 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) β€” inherited 🧚
  • static void removeName (SoBase *const base, const char *const name) β€” inherited 🧚
  • static void incrementCurrentWriteCounter (void) β€” inherited 🧚
  • static void decrementCurrentWriteCounter (void) β€” inherited 🧚
  • static SoBase * getNamedBase (const SbName &name, SoType type) β€” inherited 🧚
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) β€” inherited 🧚
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) β€” inherited 🧚
  • static void setInstancePrefix (const SbString &c) β€” inherited 🧚
  • static void setTraceRefs (SbBool trace) β€” inherited 🧚
  • static SbBool getTraceRefs (void) β€” inherited 🧚
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) β€” inherited 🧚
  • static SbBool readRoute (SoInput *input) β€” inherited 🧚

πŸ’… Public Attributes

  • SoSFInt32 value β€” the actual integer parameter, the star of the show πŸ‘‘

Public Attributes inherited from SoShaderParameter

  • SoSFString name β€” inherited πŸŽ€
  • SoSFInt32 identifier β€” inherited πŸŽ€

🌸 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const β€” protected, inherited vibes only 🫢

Protected Member Functions inherited from SoUniformShaderParameter

  • SoGLShaderParameter * getGLShaderParameter (const uint32_t cachecontext) β€” inherited πŸ¦‹
  • void ensureParameter (SoGLShaderObject *shader) β€” inherited πŸ¦‹

Protected Member Functions inherited from SoShaderParameter

  • SoShaderParameter () β€” the constructor, protected, no deets πŸ“
  • virtual ~SoShaderParameter () β€” the destructor, also protected πŸ“

Protected Member Functions inherited from SoNode

  • SoNode (void) β€” inherited πŸ“
  • virtual ~SoNode () β€” inherited πŸ“
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) β€” inherited πŸ“

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) β€” inherited 🌈
  • virtual ~SoFieldContainer () β€” inherited 🌈

Protected Member Functions inherited from SoBase

  • SoBase (void) β€” inherited πŸ’œ
  • virtual ~SoBase () β€” inherited πŸ’œ
  • virtual void destroy (void) β€” inherited πŸ’œ
  • SbBool hasMultipleWriteRefs (void) const β€” inherited πŸ’œ
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const β€” inherited πŸ’œ
  • void writeFooter (SoOutput *out) const β€” inherited πŸ’œ
  • virtual const char * getFileFormatName (void) const β€” inherited πŸ’œ
  • virtual SoNotRec createNotRec (void) β€” inherited πŸ’œ

⭐ Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void) β€” static, protected, no notes πŸ’«

Static Protected Member Functions inherited from SoUniformShaderParameter

  • static const SoFieldData ** getFieldDataPtr (void) β€” inherited πŸ¦‹

Static Protected Member Functions inherited from SoShaderParameter

  • static const SoFieldData ** getFieldDataPtr (void) β€” inherited πŸ“

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) β€” inherited ⭐
  • static void setNextActionMethodIndex (int index) β€” inherited ⭐
  • static int getNextActionMethodIndex (void) β€” inherited ⭐
  • static void incNextActionMethodIndex (void) β€” inherited ⭐
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) β€” inherited ⭐

Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) β€” inherited 🧚
  • static void staticDataLock (void) β€” inherited 🧚
  • static void staticDataUnlock (void) β€” inherited 🧚

🌈 Additional Inherited Members

Public Types inherited from SoNode

the enum, in all its glory, every single value, don't blink bestie:

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, inherited 🫢

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn β€” protected, inherited 🫢

Static Protected Attributes inherited from SoNode

  • static SbUniqueId nextUniqueId = 1 β€” static, protected, and yes it starts at 1 ⭐
  • static int nextActionMethodIndex = 0 β€” static, protected, starts at 0 ⭐

πŸ“– Detailed Description

The SoShaderParameter1i class is used to define an integer value as shader parameter.

that's the whole deal, bestie β€” one integer, straight to the shader, no cap πŸ’–


and we are not done yet, the next chunk keeps rolling πŸ’…

✨ Member Function Documentation ✨

Here's where we get into the actual functions, bestie β€” the lil methods that do the work behind the scenes. Buckle up πŸŽ€


🌸 SoType SoShaderParameter1i::getClassTypeId (void ) β€” [static]

This static method returns the SoType object associated with objects of this class.

Lowkey iconic behavior: ask the class itself for its type, no instance needed πŸ’…

🌈 SoType SoShaderParameter1i::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.

fr fr this is how the library figures out what you actually are at runtime before it casts you down the inheritance tree πŸ‘‘

Reimplemented from SoUniformShaderParameter.

πŸ¦‹ const SoFieldData ** SoShaderParameter1i::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.

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

ngl if you're not hacking on Coin itself, this one is not your main character moment πŸ™ˆ it's giving "internal business, nothing to see here"

πŸ’œ const SoFieldData * SoShaderParameter1i::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.

yes, NULL β€” that's your cue that there's just nothing there, no drama ✨

Reimplemented from SoUniformShaderParameter.

πŸŽ€ void SoShaderParameter1i::updateParameter (SoGLShaderObject * shaderObject) β€” [virtual]

Updates the shader parameter in the OpenGL state with the content of the value field.

So basically: whatever's chilling in value gets pushed out into the OpenGL state. That's the whole job. She ate and left no crumbs πŸ”₯

Implements SoUniformShaderParameter.


🫢 Member Data Documentation 🫢

⭐ SoSFInt32 SoShaderParameter1i::value

The shader parameter value.

Yep. That's the one. The actual number your shader is getting fed πŸ’–


πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for Coin from the source code.


And that's a wrap on SoShaderParameter1i(3), bestie!! πŸ’… This whole thing is from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00 β€” go forth and parameterize your shaders responsibly, ily, mwah πŸ˜­πŸ’–βœ¨

πŸ“¦ where this page comes from