---

title: ComputeBuiltinNode category: Core layout: docs

ComputeBuiltinNode

ComputeBuiltinNode represents a compute-scope builtin value that expose information about the currently running dispatch and/or the device it is running on.

This node can only be used with a WebGPU backend.

Constructor

new ComputeBuiltinNode( builtinName : string, nodeType : string )

Constructs a new compute builtin node.

builtinName | The built-in name.
---|---
nodeType | The node type.

Methods

.getBuiltinName( builder : NodeBuilder ) : string

Returns the builtin name.

builder | The current node builder.
---|---

Returns: The builtin name.

.getHash( builder : NodeBuilder ) : string

This method is overwritten since hash is derived from the built-in name.

builder | The current node builder.
---|---

Overrides: Node#getHash

Returns: The hash.

.getNodeType( builder : NodeBuilder ) : string

This method is overwritten since the node type is simply derived from nodeType..

builder | The current node builder.
---|---

Overrides: Node#getNodeType

Returns: The node type.

.hasBuiltin( builder : NodeBuilder ) : boolean

Whether the current node builder has the builtin or not.

builder | The current node builder.
---|---

Returns: Whether the builder has the builtin or not.

.setBuiltinName( builtinName : string ) : ComputeBuiltinNode

Sets the builtin name.

builtinName | The built-in name.
---|---

Returns: A reference to this node.

Source

src/nodes/gpgpu/ComputeBuiltinNode.js