SoShaderParameter1f(3)

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

<h1># ✨ NAME ✨</h1>

okay so welcome to the Coin manual, bestie 🎀 and today's main character is:

SoShaderParameter1f — the class you use to define a floating point value as a shader parameter 💅

That's it, that's the whole name section. Short, sweet, iconic, no cap 🦋

Like, literally, the entire vibe of this class is: "here is one single float, please hand it to the shader" 🌸 One value. One float. One purpose. She's focused, she's committed, she ate and left no crumbs 👑

iykyk 🫶

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoShaderParameter.h>

Inherits SoUniformShaderParameter.

okay so real quick, this class is part of the Coin shader-parameter squad, and it inherits from SoUniformShaderParameter — so it's already got that uniform energy going on. 💅

Public Member Functions 👑

  • virtual SoType getTypeId (void) const — standard Coin type-id getter, returns the SoType for this class. every node has one, it's a whole thing.
  • virtual void updateParameter (SoGLShaderObject *shaderObject) — drops the content of the value field into the OpenGL state as the shader parameter. like, that's literally its job, and it does it well. ✨

Public Member Functions inherited from SoNode

  • void setOverride (const SbBool state) — sets the override flag.
  • SbBool isOverride (void) const — tells you if override is on.
  • void setNodeType (const NodeType type) — sets the node type.
  • NodeType getNodeType (void) const — gets the node type.
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const — makes a copy of the node.
  • virtual SbBool affectsState (void) const — says whether this node affects the traversal state.
  • virtual void doAction (SoAction *action) — runs the given action on this node.
  • virtual void GLRender (SoGLRenderAction *action) — the GL render action entry point.
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — renders below the path.
  • virtual void GLRenderInPath (SoGLRenderAction *action) — renders in the path.
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — renders off the path.
  • virtual void callback (SoCallbackAction *action) — callback action handler.
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — bounding box action handler.
  • virtual void getMatrix (SoGetMatrixAction *action) — matrix action handler.
  • virtual void handleEvent (SoHandleEventAction *action) — event handling action.
  • virtual void pick (SoPickAction *action) — pick action handler.
  • virtual void rayPick (SoRayPickAction *action) — ray pick action handler.
  • virtual void search (SoSearchAction *action) — search action handler.
  • virtual void write (SoWriteAction *action) — write action handler.
  • virtual void audioRender (SoAudioRenderAction *action) — audio render action handler.
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — primitive count action.
  • virtual void grabEventsSetup (void) — sets up event grabbing.
  • virtual void grabEventsCleanup (void) — cleans up event grabbing.
  • virtual void startNotify (void) — starts the notification cycle.
  • virtual void notify (SoNotList *l) — notifies the node of a change.
  • SbUniqueId getNodeId (void) const — returns this node's unique ID.
  • virtual SoChildList * getChildren (void) const — returns the child list (or NULL if there isn't one).
  • virtual void writeInstance (SoOutput *out) — writes the instance data.
  • virtual SoNode * addToCopyDict (void) const — adds this node to the copy dictionary.
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — copies contents from another container.
  • virtual SoFieldContainer * copyThroughConnection (void) const — copies through a connection.

Public Member Functions inherited from SoFieldContainer

  • void setToDefaults (void) — resets all fields to their default values.
  • SbBool hasDefaultValues (void) const — checks if every field is at its default.
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — compares fields with another container.
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — copies field values from another container.
  • SbBool set (const char *const fielddata) — sets field values from a string.
  • void get (SbString &fielddata) — gets field values as a string.
  • virtual int getFields (SoFieldList &l) const — fills a list with the fields.
  • virtual int getAllFields (SoFieldList &l) const — fills a list with all fields, including hidden ones.
  • virtual SoField * getField (const SbName &name) const — finds a field by name.
  • virtual SoField * getEventIn (const SbName &name) const — finds an event-in by name.
  • virtual SoField * getEventOut (const SbName &name) const — finds an event-out by name.
  • SbBool getFieldName (const SoField *const field, SbName &name) const — gets the name of a given field.
  • SbBool enableNotify (const SbBool flag) — turns notification on or off.
  • SbBool isNotifyEnabled (void) const — checks if notification is enabled.
  • SbBool set (const char *fielddata, SoInput *input) — sets field values from a string, with an SoInput for resolving stuff.
  • void get (SbString &fielddata, SoOutput *out) — gets field values as a string, with an SoOutput.
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — validates a new field value.
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — adds a write reference.
  • SbBool getIsBuiltIn (void) const — returns whether this is a built-in container.
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — reports memory used by fields.
  • void setUserData (void *userdata) const — attaches user data.
  • void * getUserData (void) const — retrieves the attached user data.

Public Member Functions inherited from SoBase

  • void ref (void) const — increments the reference count.
  • void unref (void) const — decrements the reference count, deleting if it hits zero.
  • void unrefNoDelete (void) const — decrements without deleting.
  • int32_t getRefCount (void) const — returns the current reference count.
  • void touch (void) — marks the object as changed and notifies auditors.
  • SbBool isOfType (SoType type) const — returns TRUE if this object's type is either the same as type or inherited from it. basically a class-hierarchy vibe check 🦋
  • virtual SbName getName (void) const — returns the object's name.
  • virtual void setName (const SbName &newname) — sets the object's name.
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — adds an auditor.
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — removes an auditor.
  • const SoAuditorList & getAuditors (void) const — returns the list of auditors.
  • SbBool shouldWrite (void) — checks if the object should be written.
  • void assertAlive (void) const — asserts that the object is still alive.

Static Public Member Functions 🌟

  • static SoType getClassTypeId (void) — returns the SoType for this class.
  • static void initClass () — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. iconic housekeeping, no cap ✨

Static Public Member Functions inherited from SoUniformShaderParameter

  • static SoType getClassTypeId (void) — same deal, returns the class type ID.
  • 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) — returns the class type ID.
  • 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) — gets compatibility types.
  • static SoType getClassTypeId (void) — returns the class type ID.
  • static SoNode * getByName (const SbName &name) — finds a node by name.
  • static int getByName (const SbName &name, SoNodeList &l) — finds all nodes with a given name and puts them in the list.
  • 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) — initializes all classes.
  • static SbUniqueId getNextNodeId (void) — returns the next unique node ID.
  • static int getActionMethodIndex (const SoType type) — returns the action method index for a type.
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — static bounding box handler.
  • static void GLRenderS (SoAction *action, SoNode *node) — static GL render handler.
  • static void callbackS (SoAction *action, SoNode *node) — static callback handler.
  • static void getMatrixS (SoAction *action, SoNode *node) — static matrix handler.
  • static void handleEventS (SoAction *action, SoNode *node) — static event handler.
  • static void pickS (SoAction *action, SoNode *node) — static pick handler.
  • static void rayPickS (SoAction *action, SoNode *node) — static ray pick handler.
  • static void searchS (SoAction *action, SoNode *node) — static search handler.
  • static void writeS (SoAction *action, SoNode *node) — static write handler.
  • static void audioRenderS (SoAction *action, SoNode *node) — static audio render handler.
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — static primitive count handler.

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) — cleans up the class.
  • static void initCopyDict (void) — initializes the copy dictionary.
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — adds a copy to the dictionary.
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks for a copy.
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — finds a copy.
  • static void copyDone (void) — signals that copying is done.

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) — adds a name to the name list.
  • static void removeName (SoBase *const base, const char *const name) — removes a name.
  • static void incrementCurrentWriteCounter (void) — bumps the write counter.
  • static void decrementCurrentWriteCounter (void) — lowers the write counter.
  • static SoBase * getNamedBase (const SbName &name, SoType type) — gets a named base.
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — gets named bases into a list.
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads a base from input.
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix.
  • static void setTraceRefs (SbBool trace) — turns reference tracing on or off.
  • static SbBool getTraceRefs (void) — checks if reference tracing is on.
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connects a route.
  • static SbBool readRoute (SoInput *input) — reads a route.

Public Attributes 🎀

  • SoSFFloat value — the floating point value that gets passed as the shader parameter. the main character, honestly. 💅

Public Attributes inherited from SoShaderParameter

  • SoSFString name — the parameter name.
  • SoSFInt32 identifier — the parameter identifier.

Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const — returns the field data for this class.

Protected Member Functions inherited from SoUniformShaderParameter

  • SoGLShaderParameter * getGLShaderParameter (const uint32_t cachecontext) — gets the GL shader parameter for a cache context.
  • void ensureParameter (SoGLShaderObject *shader) — makes sure the parameter exists for the shader.

Protected Member Functions inherited from SoShaderParameter

  • SoShaderParameter () — constructor.
  • virtual ~SoShaderParameter () — destructor.

Protected Member Functions inherited from SoNode

  • SoNode (void) — constructor.
  • virtual ~SoNode () — destructor.
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance.

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) — constructor.
  • virtual ~SoFieldContainer () — destructor.

Protected Member Functions inherited from SoBase

  • SoBase (void) — constructor.
  • virtual ~SoBase () — destructor.
  • virtual void destroy (void) — destroys the object.
  • SbBool hasMultipleWriteRefs (void) const — checks for multiple write references.
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes a header.
  • void writeFooter (SoOutput *out) const — writes a footer.
  • virtual const char * getFileFormatName (void) const — gets the file format name.
  • virtual SoNotRec createNotRec (void) — creates a notification record.

Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void) — returns a pointer to the field data pointer.

Static Protected Member Functions inherited from SoUniformShaderParameter

  • static const SoFieldData ** getFieldDataPtr (void) — same, returns the field data pointer.

Static Protected Member Functions inherited from SoShaderParameter

  • static const SoFieldData ** getFieldDataPtr (void) — returns the field data pointer.

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — returns the field data pointer.
  • static void setNextActionMethodIndex (int index) — sets the next action method index.
  • static int getNextActionMethodIndex (void) — gets the next action method index.
  • static void incNextActionMethodIndex (void) — increments the next action method index.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types for a node type.

Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) — gets the current write counter.
  • static void staticDataLock (void) — locks static data.
  • static void staticDataUnlock (void) — unlocks static data.

Additional Inherited Members

Public Types inherited from SoNode

  • enum NodeType — the node type bitmask enum. values are:
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 — flags for base objects:
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Protected Attributes inherited from SoNode

  • SbUniqueId uniqueId — the unique ID for this node.

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — whether this field container is built-in.

Static Protected Attributes inherited from SoNode

  • static SbUniqueId nextUniqueId = 1 — the next unique ID to hand out.
  • static int nextActionMethodIndex = 0 — the next action method index.

Detailed Description

The SoShaderParameter1f class is used to define a floating point value as shader parameter. like, you literally use it to hand a float over to your shader as a parameter — that's the whole plot. 🌸

💖 Member Function Documentation 💖

✨ SoType SoShaderParameter1f::getClassTypeId (void ) [static]

Bestie. This static method hands you back the SoType object that's associated with objects of this class. That's it, that's the whole job, and it does it flawlessly. 💅

🦋 SoType SoShaderParameter1f::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. What's that for, you ask? Runtime type checking and "downward" casting, periodt. 👑

Heads up: this one is reimplemented from SoUniformShaderParameter, so don't come for me, come for the inheritance chain. 🌈

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

Okay so, real talk — this API member is considered internal to the library, because it's not likely to be of interest to the application programmer. So if you're just vibing and writing app code, this is not your girl. 🙈

It returns the SoFieldData class which holds information about fields in this node. Slay. ✨

🌸 const SoFieldData * SoShaderParameter1f::getFieldData (void ) const [protected], [virtual]

Gives you a pointer to the class-wide field data storage object for this instance. And if there are literally no fields present? It returns NULL. Iconic behaviour honestly. 🫶

Also reimplemented from SoUniformShaderParameter — again, it's giving very much "family tree". 🌳

💫 void SoShaderParameter1f::updateParameter (SoGLShaderObject * shaderObject) [virtual]

The main character. ✨ This one updates the shader parameter in the OpenGL state using the content of the value field. Like, it takes your value and puts it where it belongs. Obsessed. 😭

Implements SoUniformShaderParameter — so yes, it's keeping that contract, no cap. 💜

🍓 Member Data Documentation 🍓

🌟 SoSFFloat SoShaderParameter1f::value

The shader parameter value. That's the tea. The whole point. The moment. 💖

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. (Not a human, not a girlie, just a documentation generator doing its little thing. Respect. 🎀)

And that's a wrap on SoShaderParameter1f(3), bestie!! This edition is Version 4.0.10, dated Thu Jun 25 2026 00:00:00 — so yes, she's timestamped, she's official, and she ate. 🌈✨💅 Go forth and parameterise your shaders, you absolute legend. 🦋💖

📦 where this page comes from