TSL Docs

BufferAttributeNode

Last modified: Jun 30, 2024

In earlier three.js versions it was only possible to define attribute data on geometry level. With BufferAttributeNode, it is also possible to do this on the node level.

const geometry = new THREE.PlaneGeometry();
const positionAttribute = geometry.getAttribute( 'position' );

const colors = [];
for ( let i = 0; i < position.count; i ++ ) {
	colors.push( 1, 0, 0 );
}

material.colorNode = bufferAttribute( new THREE.Float32BufferAttribute( colors, 3 ) );
export {}

This new approach is especially interesting when geometry data are generated via compute shaders. The below line converts a storage buffer into an attribute node.

material.positionNode = positionBuffer.toAttribute();
export {}

Constructor

new BufferAttributeNode(value, bufferType?, bufferStride?, bufferOffset?)

Parameter	Type	Default Value
value	`any`	—
bufferType?	`null \| string`	`null`
bufferStride?	`number`	`0`
bufferOffset?	`number`	`0`

Constructs a new buffer attribute node.

Accessor	Type
get type	`string`
Modifiers `static`

Properties

Property	Type
isBufferNode	`boolean`	—
bufferType	`null \| string`	—
bufferStride	`number`	—
bufferOffset	`number`	—
usage	`number`	—
instanced	`boolean`	—
attribute	`any`	—

Method Type

getHash (builder: NodeBuilder) => string

This method is overwritten since the attribute data might be shared and thus the hash should be shared as well.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

string

generateNodeType (builder: NodeBuilder) => string

This method is overwritten since the node type is inferred from the buffer attribute.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

string

setup (builder: NodeBuilder) => void

Depending on which value was passed to the node, setup() behaves differently. If no instance of BufferAttribute was passed, the method creates an internal attribute and configures it respectively.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

void

generate (builder: NodeBuilder) => string

Generates the code snippet of the buffer attribute node.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

string

getInputType () => string

Overwrites the default implementation to return a fixed value 'bufferAttribute'.

Returns

string

setUsage (value: number) => BufferAttributeNode

Sets the usage property to the given value.

Parameter	Type	Default Value
value	`number`	—

Returns

BufferAttributeNode

setInstanced (value: boolean) => BufferAttributeNode

Sets the instanced property to the given value.

Parameter	Type	Default Value
value	`boolean`	—

Returns

BufferAttributeNode

Extends

InputNode

bufferAttribute

TSL function for creating a buffer attribute node.

Parameter	Type	Default Value
array	`any`	—
type?	`null \| string`	`null`
stride?	`number`	`0`
offset?	`number`	`0`

Returns

Node | BufferAttributeNode

dynamicBufferAttribute

TSL function for creating a buffer attribute node but with dynamic draw usage. Use this function if attribute data are updated per frame.

Parameter	Type	Default Value
array	`any`	—
type?	`null \| string`	`null`
stride?	`number`	`0`
offset?	`number`	`0`

Returns

Node | BufferAttributeNode

instancedBufferAttribute

TSL function for creating a buffer attribute node but with enabled instancing

Parameter	Type	Default Value
array	`any`	—
type?	`null \| string`	`null`
stride?	`number`	`0`
offset?	`number`	`0`

Returns

Node | BufferAttributeNode

instancedDynamicBufferAttribute

TSL function for creating a buffer attribute node but with dynamic draw usage and enabled instancing

Parameter	Type	Default Value
array	`any`	—
type?	`null \| string`	`null`
stride?	`number`	`0`
offset?	`number`	`0`

Returns

Node | BufferAttributeNode