SoGeometryShader(3)

πŸ“¦ version 2.5.0, in fedora 43, fedora 44

πŸ’– SoGeometryShader(3) πŸ’–

Library Functions Manual β€” bestie, we're in the SoGeometryShader(3) page and it's lowkey a banger ✨


🌸 NAME 🌸

SoGeometryShader β€” the class that's literally built for loading geometry shader programs. That's it. That's the job. πŸ‘‘


✨ SYNOPSIS ✨

#include <Inventor/nodes/SoGeometryShader.h>

Inherits SoShaderObject. Yes bestie, it's giving nepo baby but in a slay way πŸ’…

πŸŽ€ 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
    }

πŸ’œ Public Member Functions πŸ’œ

virtual SoType getTypeId (void) const
SoGeometryShader (void)
virtual ~SoGeometryShader ()
virtual void GLRender (SoGLRenderAction *action)

πŸ¦‹ Public Member Functions inherited from SoShaderObject

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 SbBool isSupported (SourceType sourceType)

πŸ¦‹ Static Public Member Functions inherited from SoShaderObject

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 πŸ’…

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)
~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 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

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

The SoGeometryShader class is used for loading geometry shader programs. No cap, that is literally the whole personality. πŸ’–

If you wanna know how to set up a whole scene graph with shaders (iykyk), go read Shaders in Coin β€” it's got the full lore.

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 iconic ⭐


πŸ¦‹ Member Enumeration Documentation πŸ¦‹

🌈 enum SoGeometryShader::InputType 🌈

Enumerates the input types. Pick your vibe:

Enumerator

  • POINTS_IN β€” the shader uses points as input. Tiny little dots, main character energy ✨
  • LINES_IN β€” the shader uses lines as input. Draw the line, bestie πŸ“
  • TRIANGLES_IN β€” the shader uses triangles as input. And plot twist: OpenGL will automatically convert quads and polygons into triangles. It does the work so you don't have to πŸ’…

🌈 enum SoGeometryShader::OutputType 🌈

Enumerates the output types. Now for the glow-up:

Enumerator

  • POINTS_OUT β€” the shader generates points. Tiny dots again, but output edition πŸŽ€
  • LINE_STRIP_OUT β€” the shader generates line strips. Connected, unlike your wifi 🫢

πŸ’œ Constructor & Destructor Documentation πŸ’œ

SoGeometryShader::SoGeometryShader (void )

Constructor. It's giving new beginning 🌸

References inputType, LINE_STRIP_OUT, LINES_IN, maxEmit, outputType, POINTS_IN, POINTS_OUT, SoGeometryShader(), and TRIANGLES_IN.

Referenced by getFieldData(), and SoGeometryShader().


SoGeometryShader::~SoGeometryShader () [virtual]

Destructor. Saying goodbye is hard but we move 😭


✨ Member Function Documentation ✨

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

Okay bestie, this one is iconic β€” it hands you back the type ID of any object derived from a class that inherits SoBase. What's it for? Run-time type checking, and "downward" casting. Slay.

Usage example, and yes you're getting it verbatim because it's perfect:

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, if you're an application programmer who wants to extend the library with new nodes, engines, nodekits, draggers or whatever else β€” listen up β€” you have to override this method in all your subclasses. No skipping, no shortcuts. Normally you do that as part of setting up the whole type system for your extension classes, and the usual way is with the pre-defined macros you get from, 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 and so forth.

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

Reimplemented from SoShaderObject.


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

This one gives you a pointer to the class-wide field data storage object for this instance. And if there are no fields present? It returns NULL. That's it, that's the whole vibe.

Reimplemented from SoShaderObject.

References SoGeometryShader().


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

The action method for SoGLRenderAction. πŸ’…

This gets called during rendering traversals, okay? Any node that influences the rendering state in any way, or that wants to throw geometry primitives at OpenGL, overrides this method. That's the whole deal.

Reimplemented from SoShaderObject.

References SoAction::getState(), SoShaderObject::GLRender(), inputType, SoShaderObject::isActive, LINE_STRIP_OUT, LINES_IN, maxEmit, outputType, POINTS_IN, POINTS_OUT, SoDebugError::post(), and TRIANGLES_IN.


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

Returns a boolean telling you whether the requested source type is supported by the OpenGL driver or not. Yes or no, bestie. Binary. Periodt.

⚠️ Beware: to get a correct answer, a valid OpenGL context must be available. Like, actually available. Don't come crying to me if you skipped that part. 😭

References SoShaderObject::ARB_PROGRAM, SoShaderObject::CG_PROGRAM, SoShaderObject::GLSL_PROGRAM, and SoShaderObject::sourceType.


πŸŽ€ Member Data Documentation πŸŽ€

SoSFEnum SoGeometryShader::inputType

The type of geometry used as input to the shader. Default value is TRIANGLES_IN. 🌸

Referenced by GLRender(), and SoGeometryShader().


SoSFEnum SoGeometryShader::outputType

The type of geometry generated from the shader. Default value is TRIANGLE_FAN_OUT. ✨

Referenced by GLRender(), and SoGeometryShader().


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

Referenced by GLRender(), and SoGeometryShader().


πŸ‘‘ Author

Generated automatically by Doxygen for Coin from the source code. Not a human, no cap β€” it just spawned this whole page for you.


And that's a wrap on SoGeometryShader(3), bestie!! πŸ¦‹ This gorgeous little doc came from Coin, Version 2.5.0 β€” go forth and shade your geometry, you absolute main character. πŸ’–πŸŽ€πŸŒˆ

πŸ“¦ where this page comes from