TSL Docs

MathNode

Last modified: Jun 30, 2024

This node represents a variety of mathematical methods available in shaders. They are divided into three categories:

Methods with one input like sin , cos or normalize .
Methods with two inputs like dot , cross or pow .
Methods with three inputs like mix , clamp or smoothstep .

Constructor

new MathNode(method, aNode, bNode?, cNode?, args)

Parameter	Type	Default Value
method	`string`	—
aNode	`Node`	—
bNode?	`null \| Node`	`null`
cNode?	`null \| Node`	`null`
args	`Array<any>`	—

Constructs a new math node.

Accessor	Type
get type	`string`
Modifiers `static`

Properties

Property	Type
method	`string`	—
aNode	`Node`	—
bNode	`null \| Node`	—
cNode	`null \| Node`	—
isMathNode	`boolean`	—

Method Type

getInputType (builder: NodeBuilder) => string

The input type is inferred from the node types of the input nodes.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

string

generateNodeType (builder: NodeBuilder) => string

The selected method as well as the input type determine the node type of this node.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

string

setup (builder: any) => any

Parameter	Type	Default Value
builder	`any`	—

Returns

any

generate (builder: any, output: any) => any

Parameter	Type	Default Value
builder	`any`	—
output	`any`	—

Returns

any

serialize (data: any) => void

Parameter	Type	Default Value
data	`any`	—

Returns

void

deserialize (data: any) => void

Parameter	Type	Default Value
data	`any`	—

Returns

void

Extends

TempNode

EPSILON

A small value used to handle floating-point precision errors.

Type

Node<float>

INFINITY

Represents infinity.

Type

Node<float>

PI

Represents PI.

Type

Node<float>

PI2

Represents PI * 2. Please use the non-deprecated version TWO_PI.

Type

Node<float>

TWO_PI

Represents PI * 2.

Type

Node<float>

HALF_PI

Represents PI / 2.

Type

Node<float>

all

Returns true if all components of x are true.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node<bool>

any

Returns true if any components of x are true.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node<bool>

radians

Converts a quantity in degrees to radians.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

degrees

Convert a quantity in radians to degrees.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

exp

Returns the natural exponentiation of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

exp2

Returns 2 raised to the power of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

log

Returns the natural logarithm of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

log2

Returns the base 2 logarithm of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

sqrt

Returns the square root of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

inverseSqrt

Returns the inverse of the square root of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

floor

Finds the nearest integer less than or equal to the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

ceil

Finds the nearest integer that is greater than or equal to the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

normalize

Calculates the unit vector in the same direction as the original vector.

Parameter	Type	Default Value
x	`Node`	—

Returns

Node

fract

Computes the fractional part of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

sin

Returns the sine of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

N E W

sinh

Returns the hyperbolic sine of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

cos

Returns the cosine of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

N E W

cosh

Returns the hyperbolic cosine of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

tan

Returns the tangent of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

N E W

tanh

Returns the hyperbolic tangent of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

asin

Returns the arcsine of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

N E W

asinh

Returns the inverse hyperbolic sine of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

acos

Returns the arccosine of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

N E W

acosh

Returns the inverse hyperbolic cosine of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

atan

Returns the arc-tangent of the parameter. If two parameters are provided, the result is atan2(y/x).

Parameter	Type	Default Value
y	`Node \| number`	—
x	`Node \| number`	—

Returns

Node

N E W

atanh

Returns the inverse hyperbolic tangent of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

abs

Returns the absolute value of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

sign

Extracts the sign of the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

length

Calculates the length of a vector.

Parameter	Type	Default Value
x	`Node`	—

Returns

Node<float>

negate

Negates the value of the parameter (-x).

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

oneMinus

Return 1 minus the parameter.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

dFdx

Returns the partial derivative of the parameter with respect to x.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

dFdy

Returns the partial derivative of the parameter with respect to y.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

round

Rounds the parameter to the nearest integer.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

reciprocal

Returns the reciprocal of the parameter (1/x).

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

trunc

Truncates the parameter, removing the fractional part.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

fwidth

Returns the sum of the absolute derivatives in x and y.

Parameter	Type	Default Value
x	`Node \| number`	—

Returns

Node

transpose

Returns the transpose of a matrix.

Parameter	Type	Default Value
x	`Node<mat2\|mat3\|mat4>`	—

Returns

Node

determinant

Returns the determinant of a matrix.

Parameter	Type	Default Value
x	`Node<mat2\|mat3\|mat4>`	—

Returns

Node<float>

inverse

Returns the inverse of a matrix.

Parameter	Type	Default Value
x	`Node<mat2\|mat3\|mat4>`	—

Returns

Node<mat2|mat3|mat4>

min

Returns the least of the given values.

Parameter	Type	Default Value
values	`...Node \| number`	—

Returns

Node

max

Returns the greatest of the given values.

Parameter	Type	Default Value
values	`...Node \| number`	—

Returns

Node

step

Generate a step function by comparing two values.

Parameter	Type	Default Value
x	`Node \| number`	—
y	`Node \| number`	—

Returns

Node

reflect

Calculates the reflection direction for an incident vector.

Parameter	Type	Default Value
I	`Node<vec2\|vec3\|vec4>`	—
N	`Node<vec2\|vec3\|vec4>`	—

Returns

Node<vec2|vec3|vec4>

distance

Calculates the distance between two points.

Parameter	Type	Default Value
x	`Node<vec2\|vec3\|vec4>`	—
y	`Node<vec2\|vec3\|vec4>`	—

Returns

Node<float>

difference

Calculates the absolute difference between two values.

Parameter	Type	Default Value
x	`Node \| number`	—
y	`Node \| number`	—

Returns

Node

dot

Calculates the dot product of two vectors.

Parameter	Type	Default Value
x	`Node<vec2\|vec3\|vec4>`	—
y	`Node<vec2\|vec3\|vec4>`	—

Returns

Node<float>

cross

Calculates the cross product of two vectors.

Parameter	Type	Default Value
x	`Node<vec2\|vec3>`	—
y	`Node<vec2\|vec3>`	—

Returns

Node<float|vec3>

pow

Return the value of the first parameter raised to the power of the second one.

Parameter	Type	Default Value
x	`Node \| number`	—
y	`Node \| number`	—

Returns

Node

pow2

Returns the square of the parameter.

Parameter	Type	Default Value
x	`number \| Node`	—

Returns

Node

pow3

Returns the cube of the parameter.

Parameter	Type	Default Value
x	`number \| Node`	—

Returns

Node

pow4

Returns the fourth power of the parameter.

Parameter	Type	Default Value
x	`number \| Node`	—

Returns

Node

transformDirection

Transforms the direction of a vector by a matrix and then normalizes the result.

Parameter	Type	Default Value
direction	`Node<vec2\|vec3\|vec4>`	—
matrix	`Node<mat2\|mat3\|mat4>`	—

Returns

Node

cbrt

Returns the cube root of a number.

Parameter	Type	Default Value
a	`number \| Node`	—

Returns

Node

lengthSq

Calculate the squared length of a vector.

Parameter	Type	Default Value
a	`Node<vec2\|vec3\|vec4>`	—

Returns

Node<float>

mix

Linearly interpolates between two values.

Parameter	Type	Default Value
a	`Node \| number`	—
b	`Node \| number`	—
t	`Node \| number`	—

Returns

Node

clamp

Constrains a value to lie between two further values.

Parameter	Type	Default Value
value	`number \| Node`	—
low?	`number \| Node`	`0`
high?	`number \| Node`	`1`

Returns

Node

saturate

Constrains a value between 0 and 1.

Parameter	Type	Default Value
value	`number \| Node`	—

Returns

Node

refract

Calculates the refraction direction for an incident vector.

Parameter	Type	Default Value
I	`Node<vec2\|vec3\|vec4>`	—
N	`Node<vec2\|vec3\|vec4>`	—
eta	`Node<float>`	—

Returns

Node<vec2|vec3|vec4>

smoothstep

Performs a Hermite interpolation between two values.

Parameter	Type	Default Value
low	`Node \| number`	—
high	`Node \| number`	—
x	`Node \| number`	—

Returns

Node

faceForward

Returns a vector pointing in the same direction as another.

Parameter	Type	Default Value
N	`Node<vec2\|vec3\|vec4>`	—
I	`Node<vec2\|vec3\|vec4>`	—
Nref	`Node<vec2\|vec3\|vec4>`	—

Returns

Node<vec2|vec3|vec4>

rand

Returns a random value for the given uv.

Parameter	Type	Default Value
uv	`Node<vec2>`	—

Returns

Node<float>

mixElement

Alias for mix() with a different parameter order.

Parameter	Type	Default Value
t	`number \| Node`	—
e1	`number \| Node`	—
e2	`number \| Node`	—

Returns

Node

smoothstepElement

Alias for smoothstep() with a different parameter order.

Parameter	Type	Default Value
x	`number \| Node`	—
low	`number \| Node`	—
high	`number \| Node`	—

Returns

Node

stepElement

Alias for step() with a different parameter order.

Parameter	Type	Default Value
x	`number \| Node`	—
edge	`number \| Node`	—

Returns

Node

faceforward

Type

any

inversesqrt

Type

any