Package com.openinventor.inventor.nodes

Class SoComputeShaderScheduler

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodes.SoComputeShaderScheduler

All Implemented Interfaces:

SafeDisposable

public class SoComputeShaderScheduler
extends SoNode

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

}

Since:

Open Inventor 10.12

See Also:

• SoComputeShader
• SoShaderParameterBufferObject
• SoShaderParameterImage
• SoShaderProgram

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SoComputeShaderScheduler.Policies	Scheduling Policies.

Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoNode

SoNode.RenderModes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field	Description
final SoSFVec3i32	numWorkGroups	Specifies the number of local work groups dispatched in the X, Y and Z dimensions for the computation.
final SoSFEnum<SoComputeShaderScheduler.Policies>	policy	Specifies the policy used for scheduling the computation.
final SoSFTrigger	trigger	Trigger field to execute the shader computation.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor	Description
SoComputeShaderScheduler()

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderEngineMode, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getName, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getNativeResourceHandle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

numWorkGroups

public final SoSFVec3i32 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)

policy

public final SoSFEnum<SoComputeShaderScheduler.Policies> policy

Specifies the policy used for scheduling the computation. . Default value is EACH_FRAME

trigger

public final SoSFTrigger trigger

Trigger field to execute the shader computation. Effective only if policy is ON_TRIGGER.

Constructor Details

SoComputeShaderScheduler

public SoComputeShaderScheduler()