Open Inventor Release 2024.1.3
 
Loading...
Searching...
No Matches
SoComputeShaderScheduler Class Reference

VSG extension Compute shader scheduler node More...

#include <Inventor/nodes/SoComputeShaderScheduler.h>

+ Inheritance diagram for SoComputeShaderScheduler:

Public Types

enum  Policy {
  EACH_FRAME ,
  ON_TRIGGER
}
 Scheduling Policies. More...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoComputeShaderScheduler ()
 
virtual SbBool affectsState () const
 Returns false.
 
- Public Member Functions inherited from SoNode
virtual void setOverride (const SbBool state)
 Turns the override flag on or off.
 
virtual SbBool isOverride () const
 Returns the state of the override flag.
 
virtual SoNodecopy (SbBool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual void touch ()
 Marks an instance as modified, simulating a change to it.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
SbBool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
SbBool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
SoNONUNICODE SbBool set (const char *fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
SbBool set (const SbString &fieldDataString)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends references to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual int getAllFields (SoFieldList &list) const
 Returns a list of fields, including the eventIn's and eventOut's.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (const SbName &fieldName) const
 Returns the eventOut with the given name.
 
SbBool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
SbBool enableNotify (SbBool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
SbBool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
virtual void setUserData (void *data)
 Sets application data.
 
void * getUserData (void) const
 Gets user application data.
 
- Public Member Functions inherited from SoBase
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
void setSynchronizable (const bool b)
 Sets this to be a ScaleViz synchronizable object.
 
bool isSynchronizable () const
 Gets the ScaleViz synchronizable state of this object.
 
- Public Member Functions inherited from SoRefCounter
void ref () const
 Adds a reference to an instance.
 
void unref () const
 Removes a reference from an instance.
 
void unrefNoDelete () const
 unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
 
int getRefCount () const
 Returns current reference count.
 
void lock () const
 lock this instance.
 
void unlock () const
 unlock this instance.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
static SoNodegetByName (const SbName &name)
 A node's name can be set using SoBase::setName().
 
static int getByName (const SbName &name, SoNodeList &list)
 A node's name can be set using SoBase::setName().
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Public Attributes

SoSFVec3i32 numWorkGroups
 Specifies the number of local work groups dispatched in the X, Y and Z dimensions for the computation.
 
SoSFEnum policy
 Specifies the policy used for scheduling the computation.
 
SoSFTrigger trigger
 Trigger field to execute the shader computation.
 

Detailed Description

VSG extension Compute shader scheduler node

This node allows the application to setup the invocation of a compute shader.

When traversed by a rendering action, this node launches one or more compute work groups. Each work group is processed by the current SoShaderProgram for the SoComputeShader stage.

See Compute Shader section of the OpenGL wiki for more information about the execution model of compute shaders.

FILE FORMAT/DEFAULT

    ComputeShaderScheduler {
    numWorkGroups 1 1 1
    policy EACH_FRAME
    }

SEE ALSO

SoComputeShader, SoShaderParameterBufferObject, SoShaderParameterImage, SoShaderProgram

NOTE: node available since Open Inventor 10.12

Definition at line 63 of file SoComputeShaderScheduler.h.

Member Enumeration Documentation

◆ Policy

Scheduling Policies.

Enumerator
EACH_FRAME 

The computation is executed each time this node is traversed by a rendering action.

ON_TRIGGER 

The computation is executed only if the trigger field is touched.

See trigger.

Definition at line 71 of file SoComputeShaderScheduler.h.

Constructor & Destructor Documentation

◆ SoComputeShaderScheduler()

SoComputeShaderScheduler::SoComputeShaderScheduler ( )

Member Function Documentation

◆ affectsState()

virtual SbBool SoComputeShaderScheduler::affectsState ( ) const
inlinevirtual

Returns false.

See SoNode::affectsState() for detail.

Reimplemented from SoNode.

Definition at line 113 of file SoComputeShaderScheduler.h.

◆ getClassTypeId()

static SoType SoComputeShaderScheduler::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoComputeShaderScheduler::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

Member Data Documentation

◆ numWorkGroups

SoSFVec3i32 SoComputeShaderScheduler::numWorkGroups

Specifies the number of local work groups dispatched in the X, Y and Z dimensions for the computation.

Default value is (1, 1, 1)

Definition at line 92 of file SoComputeShaderScheduler.h.

◆ policy

SoSFEnum SoComputeShaderScheduler::policy

Specifies the policy used for scheduling the computation.

Use enum Policy. Default value is EACH_FRAME

Definition at line 99 of file SoComputeShaderScheduler.h.

◆ trigger

SoSFTrigger SoComputeShaderScheduler::trigger

Trigger field to execute the shader computation.

Effective only if policy is ON_TRIGGER.

Definition at line 106 of file SoComputeShaderScheduler.h.


The documentation for this class was generated from the following file: