Constructor
new ComputeNode( computeNode : Node, workgroupSize : Array.<number> )
Constructs a new compute node.
| computeNode |
The node that defines the compute shader logic. |
| workgroupSize |
An array defining the X, Y, and Z dimensions of the workgroup for compute shader execution. |
Properties
.computeNode : Node
The node that defines the compute shader logic.
.count : number | Array.<number>
The total number of threads (invocations) to execute. If it is a number, it will be used
to automatically generate bounds checking against instanceIndex.
.countNode : UniformNode
A uniform node holding the dispatch count for bounds checking.
Created automatically when count is a number.
.dispatchSize : number | Array.<number>
The dispatch size for workgroups on X, Y, and Z axes.
Used directly if count is not provided.
.isComputeNode : boolean (readonly)
This flag can be used for type testing.
Default is true.
.onInitFunction : function
A callback executed when the compute node finishes initialization.
.updateBeforeType : string
The updateBeforeType is set to NodeUpdateType.OBJECT since ComputeNode#updateBefore
is executed once per object by default.
Default is 'object'.
- Overrides: Node#updateBeforeType
.workgroupSize : Array.<number>
An array defining the X, Y, and Z dimensions of the workgroup for compute shader execution.
Default is [ 64 ].
Methods
.dispose()
Executes the dispose event for this node.
- Overrides: Node#dispose
.label( name : string ) : ComputeNode
Sets the ComputeNode#name property.
| name |
The name of the uniform. |
- Deprecated: Yes
- Returns: A reference to this node.
.onInit( callback : function ) : ComputeNode
Sets the callback to run during initialization.
| callback |
The callback function. |
- Returns: A reference to this node.
.setName( name : string ) : ComputeNode
Sets the ComputeNode#name property.
| name |
The name of the uniform. |
- Returns: A reference to this node.
.updateBefore( frame : NodeFrame )
The method execute the compute for this node.
| frame |
A reference to the current node frame. |
- Overrides: Node#updateBefore