Skip to content

TSL: Introduce computeKernel() #31402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Jul 18, 2025
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 43 additions & 6 deletions src/nodes/gpgpu/ComputeNode.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ class ComputeNode extends Node {
*
* @param {Node} computeNode - TODO
* @param {number} count - TODO.
* @param {Array<number>} [workgroupSize=[64]] - TODO.
* @param {Array<number>} [workgroupSize = [ 64, 1, 1 ]]
*/
constructor( computeNode, count, workgroupSize = [ 64 ] ) {
constructor( computeNode, count, workgroupSize = [ 64, 1, 1 ] ) {

super( 'void' );

Expand Down Expand Up @@ -53,7 +53,7 @@ class ComputeNode extends Node {
* TODO
*
* @type {Array<number>}
* @default [64]
* @default [ 64, 1, 1 ]
*/
this.workgroupSize = workgroupSize;

Expand Down Expand Up @@ -219,10 +219,47 @@ export default ComputeNode;
* @tsl
* @function
* @param {Node} node - TODO
* @param {number} count - TODO.
* @param {Array<number>} [workgroupSize=[64]] - TODO.
* @param {number} countOrWorkgroupSize - TODO, depends on the future of count
* @returns {AtomicFunctionNode}
*/
export const compute = ( node, count, workgroupSize ) => nodeObject( new ComputeNode( nodeObject( node ), count, workgroupSize ) );
export const compute = ( node, countOrWorkgroupSize ) => {

let count = null;
let workgroupSize = [ 64, 1, 1 ]; //default

if ( Array.isArray( countOrWorkgroupSize ) ) {

workgroupSize = countOrWorkgroupSize;

if ( workgroupSize.length === 0 || workgroupSize.length > 3 ) {

throw new Error( 'workgroupSize must have 1, 2, or 3 elements' );

}

for ( let i = 0; i < workgroupSize.length; i ++ ) {

const val = workgroupSize[ i ];

if ( typeof val !== 'number' || val <= 0 || ! Number.isInteger( val ) ) {

throw new Error( `workgroupSize element at index ${i} must be a positive integer` );

}

}

// Implicit fill-up to [ x, y, z ] with 1s, just like WGSL treats @workgroup_size when fewer dimensions are specified
while ( workgroupSize.length < 3 ) workgroupSize.push( 1 );

} else {

count = countOrWorkgroupSize;

}

return nodeObject( new ComputeNode( nodeObject( node ), count, workgroupSize ) );

};

addMethodChaining( 'compute', compute );
37 changes: 35 additions & 2 deletions src/renderers/common/Renderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -2308,9 +2308,10 @@ class Renderer {
* if the renderer has been initialized.
*
* @param {Node|Array<Node>} computeNodes - The compute node(s).
* @param {Array<number>} dispatchSize - Array with [ x,y,z ] values for dispatch.
* @return {Promise|undefined} A Promise that resolve when the compute has finished. Only returned when the renderer has not been initialized.
*/
compute( computeNodes ) {
compute( computeNodes, dispatchSize = null ) {

if ( this._isDeviceLost === true ) return;

Expand Down Expand Up @@ -2351,6 +2352,38 @@ class Renderer {

}

if ( dispatchSize !== null ) {

if ( ! Array.isArray( dispatchSize ) ) {

throw new Error( 'dispatchSize must be an array' );

}

if ( dispatchSize.length === 0 || dispatchSize.length > 3 ) {

throw new Error( 'dispatchSize must have 1, 2, or 3 elements' );

}

// Check each element for positive integer
for ( let i = 0; i < dispatchSize.length; i ++ ) {

const val = dispatchSize[ i ];

if ( typeof val !== 'number' || val <= 0 || ! Number.isInteger( val ) ) {

throw new Error( `dispatchSize element at index ${i} must be a positive integer` );

}

}

// Implicit fill-up
while ( dispatchSize.length < 3 ) dispatchSize.push( 1 );

}

backend.beginCompute( computeNodes );

for ( const computeNode of computeList ) {
Expand Down Expand Up @@ -2389,7 +2422,7 @@ class Renderer {
const computeBindings = bindings.getForCompute( computeNode );
const computePipeline = pipelines.getForCompute( computeNode, computeBindings );

backend.compute( computeNodes, computeNode, computeBindings, computePipeline );
backend.compute( computeNodes, computeNode, computeBindings, computePipeline, dispatchSize );

}

Expand Down
45 changes: 29 additions & 16 deletions src/renderers/webgpu/WebGPUBackend.js
Original file line number Diff line number Diff line change
Expand Up @@ -1318,10 +1318,15 @@ class WebGPUBackend extends Backend {
* @param {Node} computeNode - The compute node.
* @param {Array<BindGroup>} bindings - The bindings.
* @param {ComputePipeline} pipeline - The compute pipeline.
* @param {Array<number>} dispatchSize - Array with [x,y,z] values for dispatch.
*/
compute( computeGroup, computeNode, bindings, pipeline ) {
compute( computeGroup, computeNode, bindings, pipeline, dispatchSize ) {

const computeNodeData = this.get( computeNode );
const { passEncoderGPU } = this.get( computeGroup );
const isValid = Array.isArray( dispatchSize );

dispatchSize = isValid ? dispatchSize : computeNodeData; //Or at some point an initial value if condition is not met and count should be depracticed

// pipeline

Expand All @@ -1340,30 +1345,38 @@ class WebGPUBackend extends Backend {

}

const maxComputeWorkgroupsPerDimension = this.device.limits.maxComputeWorkgroupsPerDimension;
if ( isValid ) {

const computeNodeData = this.get( computeNode );
passEncoderGPU.dispatchWorkgroups(
dispatchSize[ 0 ],
dispatchSize[ 1 ],
dispatchSize[ 2 ]
);

if ( computeNodeData.dispatchSize === undefined ) computeNodeData.dispatchSize = { x: 0, y: 1, z: 1 };
} else {

const { dispatchSize } = computeNodeData;
const maxComputeWorkgroupsPerDimension = this.device.limits.maxComputeWorkgroupsPerDimension;

if ( computeNode.dispatchCount > maxComputeWorkgroupsPerDimension ) {
if ( computeNodeData.dispatchSize === undefined ) computeNodeData.dispatchSize = { x: 0, y: 1, z: 1 };

dispatchSize.x = Math.min( computeNode.dispatchCount, maxComputeWorkgroupsPerDimension );
dispatchSize.y = Math.ceil( computeNode.dispatchCount / maxComputeWorkgroupsPerDimension );
if ( computeNode.dispatchCount > maxComputeWorkgroupsPerDimension ) {

} else {
dispatchSize.x = Math.min( computeNode.dispatchCount, maxComputeWorkgroupsPerDimension );
dispatchSize.y = Math.ceil( computeNode.dispatchCount / maxComputeWorkgroupsPerDimension );

} else {

dispatchSize.x = computeNode.dispatchCount;
dispatchSize.x = computeNode.dispatchCount;

}
}

passEncoderGPU.dispatchWorkgroups(
dispatchSize.x,
dispatchSize.y,
dispatchSize.z
);
passEncoderGPU.dispatchWorkgroups(
dispatchSize.x,
dispatchSize.y,
dispatchSize.z
);

}

}

Expand Down
12 changes: 9 additions & 3 deletions src/renderers/webgpu/nodes/WGSLNodeBuilder.js
Original file line number Diff line number Diff line change
Expand Up @@ -1898,7 +1898,9 @@ ${ flowData.code }

} else {

this.computeShader = this._getWGSLComputeCode( shadersData.compute, ( this.object.workgroupSize || [ 64 ] ).join( ', ' ) );
const workgroupSize = this.object.workgroupSize; //early strictly validated in computeNode

this.computeShader = this._getWGSLComputeCode( shadersData.compute, workgroupSize );

}

Expand Down Expand Up @@ -2103,6 +2105,8 @@ fn main( ${shaderData.varyings} ) -> ${shaderData.returnType} {
*/
_getWGSLComputeCode( shaderData, workgroupSize ) {

const [ workgroupSizeX, workgroupSizeY, workgroupSizeZ ] = workgroupSize;

return `${ this.getSignature() }
// directives
${shaderData.directives}
Expand All @@ -2122,11 +2126,13 @@ ${shaderData.uniforms}
// codes
${shaderData.codes}

@compute @workgroup_size( ${workgroupSize} )
@compute @workgroup_size( ${workgroupSizeX}, ${workgroupSizeY}, ${workgroupSizeZ} )
fn main( ${shaderData.attributes} ) {

// system
instanceIndex = globalId.x + globalId.y * numWorkgroups.x * u32(${workgroupSize}) + globalId.z * numWorkgroups.x * numWorkgroups.y * u32(${workgroupSize});
instanceIndex = globalId.x
+ globalId.y * (${workgroupSizeX} * numWorkgroups.x)
+ globalId.z * (${workgroupSizeX} * numWorkgroups.x) * (${workgroupSizeY} * numWorkgroups.y);

// vars
${shaderData.vars}
Expand Down
Loading