SoComputeShader Class Reference

Node that defines a compute shader. More...

#include <Inventor/nodes/SoComputeShader.h>

Inheritance diagram for SoComputeShader:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoComputeShader ()
virtual ShaderType	getShaderType () const
	Returns the shader type.
Public Member Functions inherited from SoShaderObject
template<typename UniformParamType , typename ParamValueType >
UniformParamType *	addShaderParameter (const SbString &name, ParamValueType val)
	Convenience method to create an SoShaderUniformParameter with the specified name and value and add it to the given shader object.
template<typename UniformParamType , typename ParamValueType >
void	setShaderParameter (const SbString &name, ParamValueType val)
	UniformParamType is the type of parameter to set.
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 SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
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 SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (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 SbBool	isSupported (SoShaderObject::SourceType sourceType, SoState *state=nullptr)
	Indicates if compute shaders in the specified language are supported by your graphics board.
Static Public Member Functions inherited from SoShaderObject
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 SoNode *	getByName (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.

Additional Inherited Members
Public Types inherited from SoShaderObject
enum	SourceType {   ARB_PROGRAM ,   CG_PROGRAM ,   GLSL_PROGRAM ,   FILENAME }
	Shader Object source type possible values. More...
enum	ShaderType {   VERTEX_SHADER = SbEnums::SHADER_TYPE_VERTEX ,   GEOMETRY_SHADER = SbEnums::SHADER_TYPE_GEOMETRY ,   FRAGMENT_SHADER = SbEnums::SHADER_TYPE_FRAGMENT ,   TESSELLATION_CONTROL_SHADER = SbEnums::SHADER_TYPE_TESS_CTRL ,   TESSELLATION_EVALUATION_SHADER = SbEnums::SHADER_TYPE_TESS_EVAL ,   COMPUTE_SHADER = SbEnums::SHADER_TYPE_COMPUTE }
	Type of the shader. More...
Public Attributes inherited from SoShaderObject
SoSFBool	isActive
	Specifies if the shader object is active or not.
SoSFEnum	sourceType
	Specifies the shader object's source type.
SoSFFilePathString	sourceProgram
	Contains the shader object's source program, specified by a filename (sourceType set to FILENAME) or by the string containing the program (sourceType set to GLSL_PROGRAM).
SoMFUniformShaderParameter	parameter
	Contains the shader's uniform parameters.

Detailed Description

Node that defines a compute shader.

This node defines a compute shader, a shader stage used entirely for computing arbitrary information.

To store the result of the computation, an SoComputeShader may use SoShaderParameterImage or SoShaderParameterBufferObject with SoShaderParameterBufferObject::SHADER_STORAGE_BUFFER buffer type.

To fetch data, an SoComputeShader may use the above-mentioned parameter types, or regular texture access.

See SoShaderProgram for general information about using shaders and shader parameters.

See parent class SoShaderObject for details about using the inherited fields.

See SoComputeShaderScheduler for information about compute shader invocation.

Notes & Limitations:

• Compute shaders cannot coexist with other shader stages in the same shader program. Otherwise, an error will be generated and the shader won't compile (for example, you cannot insert an SoFragmentShader along with an SoComputeShader into the field SoShaderProgram::shaderObject).
• An SoShaderProgram containing compute shaders cannot be applied on SoShape nodes. If such a shader program is present on state when a shape is traversed by a rendering action, errors might be raised and the shape will not be rendered. To avoid this case, those SoShaderProgram should be isolated in their own SoSeparator, along with the SoComputeShaderScheduler nodes.

FILE FORMAT/DEFAULT

ComputeShader {

sourceProgram	""
sourceType	FILENAME
isActive	TRUE
parameter	NULL

}

SEE ALSO

SoVertexShader, SoFragmentShader, SoGeometryShader, SoShaderObject, SoShaderProgram, SoTessellationControlShader, SoTessellationEvaluationShader, SoUniformShaderParameter, SoShaderParameterBufferObject, SoShaderParameterImage

NOTE: node available since Open Inventor 10.12

Definition at line 84 of file SoComputeShader.h.

Constructor & Destructor Documentation

SoComputeShader()

SoComputeShader::SoComputeShader

(

)

Member Function Documentation

getClassTypeId()

static SoType SoComputeShader::getClassTypeId ( )

static

Returns the type identifier for this class.

getShaderType()

virtual ShaderType SoComputeShader::getShaderType ( ) const

inlinevirtual

Returns the shader type.

Implements SoShaderObject.

Definition at line 100 of file SoComputeShader.h.

getTypeId()

virtual SoType SoComputeShader::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoShaderObject.

isSupported()

static SbBool SoComputeShader::isSupported ( SoShaderObject::SourceType  sourceType, SoState *  state = nullptr  )

static

Indicates if compute shaders in the specified language are supported by your graphics board.

When using a debug build of Open Inventor, warning messages such as "no context available" may be generated. You can ignore them or see SoGLExtension for an example of using SoGLContext to avoid them.

---

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

• Inventor/nodes/SoComputeShader.h