SoComputeShaderScheduler Class Reference
[Shaders]

Compute shader scheduler node More...

#include <Inventor/nodes/SoComputeShaderScheduler.h>

Inheritance diagram for SoComputeShaderScheduler:

List of all members.

Public Types
enum	Policy {   EACH_FRAME,   ON_TRIGGER }
Public Member Functions
virtual SoType	getTypeId () const
	SoComputeShaderScheduler ()
virtual SbBool	affectsState () const
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFVec3i32	numWorkGroups
SoSFEnum	policy
SoSFTrigger	trigger

---

Detailed Description

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

---

Member Enumeration Documentation

enum SoComputeShaderScheduler::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.

---

Constructor & Destructor Documentation

SoComputeShaderScheduler::SoComputeShaderScheduler

(

)

---

Member Function Documentation

virtual SbBool SoComputeShaderScheduler::affectsState

(

)

const [inline, virtual]

Returns false.

See SoNode::affectsState() for detail.

Reimplemented from SoNode.

static SoType SoComputeShaderScheduler::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoNode.

virtual SoType SoComputeShaderScheduler::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoNode.

---

Member Data Documentation

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)

SoSFEnum SoComputeShaderScheduler::policy

Specifies the policy used for scheduling the computation.

Use enum Policy. Default value is EACH_FRAME

SoSFTrigger SoComputeShaderScheduler::trigger

Trigger field to execute the shader computation.

Effective only if policy is ON_TRIGGER.

---

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

• Inventor/nodes/SoComputeShaderScheduler.h