TSL Docs

UniformArrayNode

Last modified: Jul 26, 2024

Similar to BufferNode this module represents array-like data as uniform buffers. Unlike BufferNode, it can handle more common data types in the array (e.g three.js primitives) and automatically manage buffer padding. It should be the first choice when working with uniforms buffers.

const tintColors = uniformArray( [
	new Color( 1, 0, 0 ),
	new Color( 0, 1, 0 ),
	new Color( 0, 0, 1 )
], 'color' );

const redColor = tintColors.element( 0 );
export {}

Constructor

new UniformArrayNode(value, elementType?)

Parameter	Type	Default Value
value	`Array<any>`	—
elementType?	`null \| string`	`null`

Constructs a new uniform array node.

Accessor	Type
get type	`string`
Modifiers `static`

Properties

Property	Type
array	`Array<any>`	—
elementType	`string`	—
paddedType	`string`	—
isArrayBufferNode	`boolean`	—

Method Type

generateNodeType () => string

This method is overwritten since the node type is inferred from the UniformArrayNode#paddedType.

Returns

string

getElementType () => string

The data type of the array elements.

Returns

string

getPaddedType () => string

Returns the padded type based on the element type.

Returns

string

update () => void

The update makes sure to correctly transfer the data from the (complex) objects in the array to the internal, correctly padded value buffer.

Returns

void

setup (builder: NodeBuilder) => null

Implement the value buffer creation based on the array data.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

null

element (indexNode: IndexNode) => UniformArrayElementNode

Overwrites the default element() method to provide element access based on UniformArrayNode.

Parameter	Type	Default Value
indexNode	`IndexNode`	—

Returns

UniformArrayElementNode

Extends

BufferNode

uniformArray

TSL function for creating an uniform array node.

Parameter	Type	Default Value
values	`Array<any>`	—
nodeType?	`null \| string`	—

Returns

UniformArrayNode