TSL Docs

InputNode

Last modified: Jun 30, 2024

Base class for representing data input nodes.

Constructor

new InputNode(value, nodeType?)

Parameter	Type	Default Value
value	`any`	—
nodeType?	`null \| string`	`null`

Constructs a new input node.

Accessor	Type
get type	`string`
Modifiers `static`

Properties

Property	Type
isInputNode	`boolean`	—
value	`any`	—
precision	`null \| "low" \| "medium" \| "high"`	—

Method Type

generateNodeType () => null | string

Returns

null | string

getInputType (builder: NodeBuilder) => string

Returns the input type of the node which is by default the node type. Derived modules might overwrite this method and use a fixed type or compute one analytically.

A typical example for different input and node types are textures. The input type of a normal RGBA texture is texture whereas its node type is vec4.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

string

setPrecision (precision: "low" | "medium" | "high") => InputNode

Sets the precision to the given value. The method can be overwritten in derived classes if the final precision must be computed analytically.

Parameter	Type	Default Value
precision	`"low" \| "medium" \| "high"`	—

Returns

InputNode

serialize (data: any) => void

Parameter	Type	Default Value
data	`any`	—

Returns

void

deserialize (data: any) => void

Parameter	Type	Default Value
data	`any`	—

Returns

void

generate () => void

Returns

void

Extends

Node