Chapter 516: WorkgroupInfoNode

Core Idea

A node allowing the user to create a 'workgroup' scoped buffer within the context of a compute shader. Typically, workgroup scoped buffers are created to hold data that is transferred from a global storage scope into a local workgroup scope. For invocations within a workgroup, data access speeds on 'workgroup' scoped buffers can be significantly faster than similar access operations on globally accessible storage buffers.

This node can only be used with a WebGPU backend.

Key Concepts

• bufferCount : number: The buffer count.
• bufferType : string: The buffer type.
• elementType : string: The data type of the array buffer.
• isWorkgroupInfoNode : boolean (readonly): This flag can be used for type testing.
• name : string: The name of the workgroup scoped buffer.
• scope : string: TODO.

Reference Tables

Constructor

Signature
new WorkgroupInfoNode( scope : string, bufferType : string, bufferCount : number )

Properties

Property	Description
.bufferCount : number	The buffer count.
.bufferType : string	The buffer type.
.elementType : string	The data type of the array buffer.
.isWorkgroupInfoNode : boolean (readonly)	This flag can be used for type testing.
.name : string	The name of the workgroup scoped buffer.
.scope : string	TODO.

Methods

Method	Description
.element( indexNode : IndexNode ) : WorkgroupInfoElementNode	This method can be used to access elements via an index node.
.getElementType() : string	The data type of the array buffer.
.getInputType( builder : NodeBuilder ) : string	Overwrites the default implementation since the input type is inferred from the scope.
.label( name : string ) : WorkgroupInfoNode	Sets the name/label of this node.
.setName( name : string ) : WorkgroupInfoNode	Sets the name of this node.
.setScope( scope : string ) : WorkgroupInfoNode	Sets the scope of this node.

Key Takeaways

1. WorkgroupInfoNode extends: EventDispatcher → Node
2. Most relevant properties: bufferCount, bufferType, elementType, isWorkgroupInfoNode.
3. Key methods: element, getElementType, getInputType, label.

Connects To

• EventDispatcher: parent class
• Node: parent class
• Source: src/nodes/gpgpu/WorkgroupInfoNode.js