SoShaderObject(3)

📦 version 3.1.3, in fedora 43, fedora 44

✨ NAME ✨

So, bestie, this is the manual page for SoShaderObject — it lives in the Library Functions Manual section of the man pages, so it's filed under SoShaderObject(3). It's the main-character shader class, and here's everything you need to know about it. 💖

🎀 SYNOPSIS 🎀

#include <Inventor/nodes/SoShaderObject.h>

It Inherits SoNode.

And it's Inherited by SoFragmentShader, SoGeometryShader, and SoVertexShader. So those three are the glow-up children, and this one is the parent holding it all together. 🫶

🌸 Public Types

  • enum SourceType { ARB_PROGRAM, CG_PROGRAM, GLSL_PROGRAM, FILENAME }

✨ Public Types inherited from SoNode

Like, this whole vibe is handed down from SoNode, no cap:

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 }

💅 Public Member Functions

  • virtual SoType getTypeId (void) const
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void search (SoSearchAction *action)
  • void updateParameters (SoState *state)
  • SourceType getSourceType (void) const
  • SbString getSourceProgram (void) const

✨ 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 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 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)
  • uint32_t 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
  • 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 (void)

✨ 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)
  • static void initClasses (void)
  • static uint32_t 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)
  • static SoType getClassTypeId (void)
  • 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)
  • static SoType getClassTypeId (void)
  • 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

  • SoSFBool isActive
  • SoSFEnum sourceType
  • SoSFString sourceProgram
  • SoMFNode parameter

💜 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const
  • SoShaderObject (void)
  • virtual ~SoShaderObject ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)

✨ Protected Member Functions inherited from SoNode

  • SoNode (void)
  • virtual ~SoNode ()

✨ 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

🧚 Static Protected Member Functions

  • 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

  • Protected Types inherited from SoBase
    • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
  • Protected Attributes inherited from SoNode
    • uint32_t uniqueId
  • Protected Attributes inherited from SoFieldContainer
    • SbBool isBuiltIn
  • Static Protected Attributes inherited from SoNode
    • static uint32_t nextUniqueId = 1
    • static int nextActionMethodIndex = 0

👑 Detailed Description

Okay so the tea: the SoShaderObject class is the superclass for all shader classes in Coin. She's the mother of the whole shader fam, fr fr.

See Shaders in Coin for more information on how to set up a scene graph with shaders. 🌸

See also:

  • SoShaderProgram

💀 Member Enumeration Documentation

enum SoShaderObject::SourceType

This one is used for enumerating the shader types in sourceProgram. Iconic behaviour honestly. ✨

Enumerator:

  • ARB_PROGRAM — Specifies an ARB shader.
  • CG_PROGRAM — Specifies a Cg shader program.
  • GLSL_PROGRAM — Specifies a GLSL program.
  • FILENAME — Shader should be loaded from the file in sourceProgram.

🎀 Constructor & Destructor Documentation

SoShaderObject::SoShaderObject (void ) [protected]

Constructor. She's born. 💖

SoShaderObject::~SoShaderObject () [protected], [virtual]

Destructor. She's gone but never forgotten. 😭

And that's where part 1 wraps up — part 2 is still loading, so hold tight bestie, there's more to this lore... 👀💅

SoType SoShaderObject::getTypeId (void ) const — [virtual] ✨

okay bestie, this one is the identity check of the whole class hierarchy. It hands you back the type identification of any object derived from a class that inherits SoBase, and it's literally what makes run-time type checking and "downward" casting possible. iykyk.

Usage example, copy it exactly bestie:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

Now, for the application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses, no skips. That's typically done as part of setting up the full type system for extension classes, and it's usually accomplished by using the pre-defined macros available through, for instance, Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. slay.

Want more on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. 🫶

  • Implements SoBase.
  • Reimplemented in SoFragmentShader, SoGeometryShader, and SoVertexShader.

const SoFieldData * SoShaderObject::getFieldData (void ) const — [protected], [virtual] 💅

Returns a pointer to the class-wide field data storage object for this instance. That's it, that's the job. And heads up: if there are no fields present, it returns NULL. NULL. as in nothing, as in empty, as in no fields bestie.

  • Reimplemented from SoFieldContainer.
  • Reimplemented in SoFragmentShader, SoGeometryShader, and SoVertexShader.

void SoShaderObject::GLRender (SoGLRenderAction * action) — [virtual] 🔥

This is the action method for the SoGLRenderAction, and it gets called during rendering traversals. Any node that influences the rendering state in any way whatsoever, or who just wants to throw geometry primitives at OpenGL, overrides this method. main character energy, honestly.

  • Reimplemented from SoNode.
  • Reimplemented in SoGeometryShader.

void SoShaderObject::search (SoSearchAction * action) — [virtual] 🔍

Action method for SoSearchAction. It compares the search criteria from the action to see if this node is a match. The searching is done by matching up all the criteria set up in the SoSearchAction — and if any of the requested criteria is a miss, then nope, the search is not deemed successful for the node. all or nothing, periodt.

See also

  • SoSearchAction
  • Reimplemented from SoNode.

void SoShaderObject::updateParameters (SoState * state) 🛠️

Used internally to update shader parameters. that's the whole thing, she's a private little helper girlie.

SoShaderObject::SourceType SoShaderObject::getSourceType (void ) const 🌈

Returns the shader type detected in sourceProgram. so if you ever wondered "what kind of shader is this actually", here's your answer bestie.

SbString SoShaderObject::getSourceProgram (void ) const 📜

Returns the actual shader program. the real one. the whole thing. iconic.

SbBool SoShaderObject::readInstance (SoInput * in, unsigned short flags) — [protected], [virtual] 🧚

This method is mainly intended for internal use during file import operations, so don't come for her, she's doing backend work.

It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. And the import process should be robust and handle corrupted input streams by returning FALSE — no crashing out, no drama, just FALSE. 💀

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

  • Reimplemented from SoNode.

🌸 MEMBER DATA DOCUMENTATION 🌸

SoSFBool SoShaderObject::isActive 🎀

Enables/disables the shader. Default value is TRUE. so out of the box she's ON, living her best life.

SoSFEnum SoShaderObject::sourceType 🦋

The type of shader.

SoSFString SoShaderObject::sourceProgram 💜

The shader program, or a file name if the shader should be loaded from a file. And here's the cute part — if the shader is loaded from a file, the shader type is identified by the file extension. So: .glsl for GLSL shaders, .cg for Cg shaders, and .vp and .fp for ARB shaders. the extension is the vibe check, basically. ✨

SoMFNode SoShaderObject::parameter 🍓

The shader program parameters.

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. not a human author, a robot, and honestly she ate.

and that's the whole page bestie!! 💖 footer says Coin, Version 3.1.3, page SoShaderObject(3) — no date on this one, she's mysterious like that. go forth and shader, love u, bye 🫶✨

📦 where this page comes from