SoGeometryShader(3)

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

πŸŽ€ NAME πŸŽ€

SoGeometryShader β€” bestie, this is the class you reach for when you want to load geometry shader programs. That's the whole job description. She does one thing and she does it gorgeously. πŸ’–

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoGeometryShader.h>

She inherits from SoShaderObject, so everything her parent can do, she can do too. It's giving nepo baby but make it graphics. πŸ‘‘

🌸 Public Types 🌸

enum InputType { POINTS_IN, LINES_IN, TRIANGLES_IN }
enum OutputType { POINTS_OUT, LINE_STRIP_OUT, TRIANGLE_STRIP_OUT }

πŸ’œ Public Types β€” inherited from SoShaderObject πŸ’œ

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,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

🫢 Public Member Functions 🫢

  • virtual SoType getTypeId (void) const β€” classic Coin move, tells you what type she is.
  • SoGeometryShader (void) β€” the constructor, the birth, the origin story.
  • virtual ~SoGeometryShader () β€” the destructor. She leaves the chat.
  • virtual void GLRender (SoGLRenderAction *action) β€” this is where the actual rendering goes down, bestie. πŸ”₯

πŸ’… Public Member Functions β€” inherited from SoShaderObject πŸ’…

  • virtual void search (SoSearchAction *action)
  • void render (SoState *state)
  • 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)
  • 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 β€” hands you back TRUE if the type of this object is either of the same type or inherited from type. Slay. ✨
  • 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) β€” sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 🫢
  • static SbBool isSupported (SourceType sourceType)

🌸 Static Public Member Functions β€” inherited from SoShaderObject 🌸

  • 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 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.
  • 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 πŸ‘‘

  • SoSFEnum inputType
  • SoSFEnum outputType
  • SoSFInt32 maxEmit

πŸ’… Public Attributes β€” inherited from SoShaderObject πŸ’…

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

πŸ“ Protected Member Functions πŸ“

  • virtual const SoFieldData * getFieldData (void) const

🌈 Protected Member Functions β€” inherited from SoShaderObject 🌈

  • 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
  • virtual SoNotRec createNotRec (void)

⭐ Static Protected Member Functions ⭐

  • static const SoFieldData ** getFieldDataPtr (void)

πŸ¦‹ Static Protected Member Functions β€” inherited from SoShaderObject πŸ¦‹

  • 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 🌈

  • SbUniqueId uniqueId

πŸ’– Protected Attributes β€” inherited from SoFieldContainer πŸ’–

  • SbBool isBuiltIn

⭐ Static Protected Attributes β€” inherited from SoNode ⭐

  • static SbUniqueId nextUniqueId = 1
  • static int nextActionMethodIndex = 0
okay bestie, that's the whole top half of the page β€” every single type, member function, attribute, and inherited goodie accounted for, no cap. 🫑

part 2 is coming, don't you dare close the tab πŸ’…

Detailed Description πŸ’–

The SoGeometryShader class is literally the whole vibe for loading geometry shader programs. That's it, that's the job. ✨

Wanna know how to actually set up a scene graph with shaders? Go read Shaders in Coin, bestie, it's all in there. πŸ“š

FILE FORMAT/DEFAULTS:

GeometryShader {
  isActive TRUE
  sourceType FILENAME
  sourceProgram ""
  parameter []
  inputType TRIANGLES_IN
  outputType TRIANGLE_STRIP_OUT
  maxEmit 8
}

See also πŸ‘€

  • SoShaderObject
  • SoShaderProgram

Since πŸ•°οΈ

Coin 2.5. vintage but make it iconic. πŸ’…

Member Enumeration Documentation 🧚

enum SoGeometryShader::InputType

Enumerates the input types, i.e. the tea on what kind of geometry is showing up to the party. πŸŽ€

Enumerator

  • POINTS_IN β€” shader takes points as input. dots. little guys. πŸ”΅
  • LINES_IN β€” shader takes lines as input. πŸ“
  • TRIANGLES_IN β€” shader takes triangles as input. and OpenGL will automatically convert quads and polygons into triangles for you, no cap. πŸ”Ίβœ¨

enum SoGeometryShader::OutputType

Enumerates the output types, i.e. what the shader is gonna serve when it's done. πŸ‘‘

Enumerator

  • POINTS_OUT β€” shader generates points. 🫧
  • LINE_STRIP_OUT β€” shader generates line strips. 〰️
  • TRIANGLE_STRIP_OUT β€” shader generates triangle strips. πŸ”ΊπŸ”ΊπŸ”Ί

Constructor & Destructor Documentation 🌸

SoGeometryShader::SoGeometryShader (void )

Constructor. it's giving born. 🐣✨

SoGeometryShader::~SoGeometryShader () [virtual]

Destructor. it's giving goodbye. πŸ˜­πŸ’”

Member Function Documentation πŸ¦‹

SoType SoGeometryShader::getClassTypeId (void ) [static]

This static method hands you back the SoType object associated with objects of this class. πŸͺͺ✨

SoType SoGeometryShader::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is what does runtime type checking and "downward" casting, iykyk. πŸ”

Reimplemented from SoShaderObject.

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

This API member is considered internal to the library, because it's not likely to be of interest to the application programmer. basically not your business, bestie, no shade. πŸ™ˆ

Returns the SoFieldData class which holds information about fields in this node. πŸ“¦

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

Returns a pointer to the class-wide field data storage object for this instance. If there are no fields present, it returns NULL. that's the whole answer. 🫢

Reimplemented from SoShaderObject.

void SoGeometryShader::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction. 🎬

This gets called during rendering traversals. Nodes that influence the rendering state in any way, or that wanna throw geometry primitives at OpenGL, override this method. main character behaviour fr fr. πŸ‘‘

Reimplemented from SoShaderObject.

SbBool SoGeometryShader::isSupported (SourceType sourceType) [static]

Returns a boolean indicating whether the requested source type is supported by the OpenGL driver or not. βœ… / ❌

Beware: to get a correct answer, a valid OpenGL context must be available. no context, no truth, periodt. πŸ’€

Member Data Documentation πŸ“

SoSFEnum SoGeometryShader::inputType

The type of geometry used as input to the shader. Default value is TRIANGLES_IN. πŸ”Ί

SoSFEnum SoGeometryShader::outputType

The type of geometry generated from the shader. Default value is TRIANGLE_FAN_OUT. πŸ”ΊπŸŒˆ

okay so the file format block up top says TRIANGLE_STRIP_OUT and this line says TRIANGLE_FAN_OUT β€” we don't make the rules, we just faithfully report them. πŸ’€ keeping it exactly as written.

SoSFInt32 SoGeometryShader::maxEmit

The maximum number of vertices emitted from the shader. Default value is 8. This corresponds to the GL_GEOMETRY_VERTICES_OUT_EXT enum. 🎱

Author 🫢

Generated automatically by Doxygen for Coin from the source code. the robot wrote it, we just made it cute. πŸ€–πŸ’…

and that's the whole page, bestie!! πŸŽ€ this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and the page is SoGeometryShader(3) β€” slay, go load some geometry shaders, you got this. πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from