SoShaderObject(3)

📦 version 2.5.0, in fedora 43, fedora 44

NAME 🎀

SoShaderObject — that's her, bestie. The icon, the blueprint, the whole vibe for shader classes in Coin.

SYNOPSIS ✨

Welcome to SoShaderObject(3) from the Library Functions Manual. This is the page you opened because shaders are calling and you're ready.

#include <Inventor/nodes/SoShaderObject.h>

Inherits SoNode.

Inherited by SoFragmentShader, SoGeometryShader, and SoVertexShader.

Public Types 💜

enum SourceType { ARB_PROGRAM, CG_PROGRAM, GLSL_PROGRAM, FILENAME }

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
    }

Public Member Functions 💅

The main squad, no skips:

  • 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=0) 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=0)
  • 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 *in)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
  • SbBool getIsBuiltIn (void) 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 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 *in, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *in)

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)
  • ~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 = 0
  • static int nextActionMethodIndex = 0

Detailed Description 💖

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

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

See also: SoShaderProgram

Since: Coin 2.5

Member Enumeration Documentation 🦋

enum SoShaderObject::SourceType 🌈

Used for enumerating the shader types in sourceProgram.

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.

References ARB_PROGRAM, CG_PROGRAM, FILENAME, GLSL_PROGRAM, isActive, parameter, SoShaderObject(), sourceProgram, and sourceType.

Referenced by getFieldData(), and SoShaderObject().

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

Destructor

💖 Member Function Documentation 💖

SoType SoShaderObject::getTypeId (void) const — virtual

okay bestie, this one hands you back the type identification of any object derived from a class that inherits SoBase. What's it for? Run-time type checking and "downward" casting, that's what. iykyk ✨

Usage example, and no I'm not paraphrasing this, it's iconic:

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

Now, for all my 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. periodt. Usually you do it as part of setting up the full type system for your extension classes, and that's normally accomplished using the pre-defined macros you get through, like, 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. 🫶

Wanna know more about writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. It's giving homework but make it cute.

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. And if there are no fields present? It returns NULL. simple as that 💅

Reimplemented from SoFieldContainer.

Reimplemented in SoFragmentShader, SoGeometryShader, and SoVertexShader.

References SoShaderObject().

void SoShaderObject::GLRender (SoGLRenderAction * action) — virtual

This is the action method for the SoGLRenderAction. It gets called during rendering traversals. So if a node influences the rendering state in any way, or if it wants to throw geometry primitives at OpenGL, it overrides this method. main character energy only 🔥

Reimplemented from SoNode.

Reimplemented in SoGeometryShader.

Referenced by SoGeometryShader::GLRender().

void SoShaderObject::search (SoSearchAction * action) — virtual

Action method for SoSearchAction, bestie.

What it does: it compares the search criteria from the action to see if this node is a match. Searching happens by matching up all the criteria set up in the SoSearchAction — so if any one of the requested criteria is a miss, the search is not deemed successful for the node. no half-matches here 🙈

See also

  • SoSearchAction

Reimplemented from SoNode.

References SoAction::getPathCode(), SoSearchAction::isFound(), parameter, SoAction::popCurPath(), SoAction::pushCurPath(), SoNode::search(), and SoNode::SoNode().

void SoShaderObject::updateParameters (SoState * state)

Used internally to update shader parameters. (internal business, you don't gotta worry about it 🎀)

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

Returns the shader type detected in sourceProgram. detective work fr fr 🦋

SbString SoShaderObject::getSourceProgram (void) const

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

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

This method is mainly intended for internal use during file import operations. lowkey behind-the-scenes stuff ✨

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 listen — the import process should be robust and handle corrupted input streams by returning FALSE. That's the vibe check and it's non-negotiable.

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

Reimplemented from SoNode.

References SoInput::getDirectories(), and SoNode::readInstance().

🌸 Member Data Documentation 🌸

SoSFBool SoShaderObject::isActive

Enabled/disables the shader. Default value is TRUE. so it's on by default, iconic behavior 👑

Referenced by SoGeometryShader::GLRender(), and SoShaderObject().

SoSFEnum SoShaderObject::sourceType

The type of shader. that's it, that's the whole description 💫

Referenced by SoFragmentShader::isSupported(), SoGeometryShader::isSupported(), SoVertexShader::isSupported(), and SoShaderObject().

SoSFString SoShaderObject::sourceProgram

The shader program, or a file name if the shader should be loaded from a file. And here's the tea: if the shader is loaded from a file, the shader type is identified by the file extension.

  • .glsl for GLSL shaders
  • .cg for Cg shaders
  • .vp and .fp for ARB shaders

Referenced by SoShaderObject().

SoMFNode SoShaderObject::parameter

The shader program parameters. 🍓

Referenced by search(), and SoShaderObject().

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code.

and that's a wrap on SoShaderObject(3) bestie!! this whole page came to you straight from Coin, Version 2.5.0 — dated, well, whenever Doxygen decided, but the version is the part that matters. slay, go compile something cute 💖✨🎀
📦 where this page comes from