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 | BufferAttributeNodeTSL 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 | BufferAttributeNodeTSL 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 | BufferAttributeNodeTSL 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 | BufferAttributeNodeTSL function for creating an expression node.
| Parameter | Type | Default Value |
|---|---|---|
| snippet? | string | — |
| nodeType? | string | — |
Returns
ExpressionNode| Parameter | Type | Default Value |
|---|---|---|
| func | any | — |
| params | ...Array<any> | — |
Returns
FunctionCallNodeTSL function for creating an array node.
| Parameter | Type | Default Value |
|---|---|---|
| params | ...Array<any> | — |
Returns
ArrayNodeTSL function for creating an assign node.
| Parameter | Type | Default Value |
|---|---|---|
| targetNode | Node | — |
| sourceNode | Node | — |
Returns
AssignNodeTSL function for creating a bypass node.
| Parameter | Type | Default Value |
|---|---|---|
| outputNode | Node | — |
| callNode | Node | — |
Returns
BypassNodeTSL function for creating a context node.
| Parameter | Type | Default Value |
|---|---|---|
| nodeOrValue? | Object | Node | null |
| value? | Object | {} |
Returns
ContextNodeTSL function for defining a uniformFlow context value for a given node.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
Returns
ContextNodeTSL function for defining a name for the context value for a given node.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| name | string | — |
Returns
ContextNodeTSL function for defining a built-in shadow context for a given node.
| Parameter | Type | Default Value |
|---|---|---|
| shadowNode | ShadowNode | — |
| light | Light | — |
| node? | Node | null |
Returns
ContextNodeTSL function for defining a built-in ambient occlusion context for a given node.
| Parameter | Type | Default Value |
|---|---|---|
| aoNode | Node | — |
| node? | Node | null |
Returns
ContextNodeTSL function for defining a label context value for a given node.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| name | string | — |
Returns
ContextNodeCreates an inspector node to wrap around a given node for inspection purposes.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| name? | string | |
| callback? | null | Function | null |
Returns
NodeTSL function for creating a cache node.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
Returns
IsolateNodeTSL function for creating a cache node.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| parent? | boolean | true |
Returns
IsolateNodeTSL function for creating a property node.
| Parameter | Type | Default Value |
|---|---|---|
| type | string | — |
| name? | null | string | null |
Returns
PropertyNodeTSL function for creating a varying property node.
| Parameter | Type | Default Value |
|---|---|---|
| type | string | — |
| name? | null | string | null |
Returns
PropertyNodeTSL object that represents the shader variable DiffuseColor.
Type
PropertyNode<vec4>TSL object that represents the shader variable DiffuseContribution.
Type
PropertyNode<vec3>TSL object that represents the shader variable EmissiveColor.
Type
PropertyNode<vec3>TSL object that represents the shader variable Roughness.
Type
PropertyNode<float>TSL object that represents the shader variable Metalness.
Type
PropertyNode<float>TSL object that represents the shader variable Clearcoat.
Type
PropertyNode<float>TSL object that represents the shader variable ClearcoatRoughness.
Type
PropertyNode<float>TSL object that represents the shader variable Sheen.
Type
PropertyNode<vec3>TSL object that represents the shader variable SheenRoughness.
Type
PropertyNode<float>TSL object that represents the shader variable Iridescence.
Type
PropertyNode<float>TSL object that represents the shader variable IridescenceIOR.
Type
PropertyNode<float>TSL object that represents the shader variable IridescenceThickness.
Type
PropertyNode<float>TSL object that represents the shader variable AlphaT.
Type
PropertyNode<float>TSL object that represents the shader variable Anisotropy.
Type
PropertyNode<float>TSL object that represents the shader variable AnisotropyT.
Type
PropertyNode<vec3>TSL object that represents the shader variable AnisotropyB.
Type
PropertyNode<vec3>TSL object that represents the shader variable SpecularColor.
Type
PropertyNode<color>TSL object that represents the shader variable SpecularColorBlended.
Type
PropertyNode<color>TSL object that represents the shader variable SpecularF90.
Type
PropertyNode<float>TSL object that represents the shader variable Shininess.
Type
PropertyNode<float>TSL object that represents the shader variable Output.
Type
PropertyNode<vec4>TSL object that represents the shader variable dashSize.
Type
PropertyNode<float>TSL object that represents the shader variable gapSize.
Type
PropertyNode<float>TSL object that represents the shader variable pointWidth.
Type
PropertyNode<float>TSL object that represents the shader variable IOR.
Type
PropertyNode<float>TSL object that represents the shader variable Transmission.
Type
PropertyNode<float>TSL object that represents the shader variable Thickness.
Type
PropertyNode<float>TSL object that represents the shader variable AttenuationDistance.
Type
PropertyNode<float>TSL object that represents the shader variable AttenuationColor.
Type
PropertyNode<color>TSL object that represents the shader variable Dispersion.
Type
PropertyNode<float>Creates a new sub-build node.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| name | string | — |
| type? | null | string | null |
Returns
NodeTSL function for creating a uniform node.
| Parameter | Type | Default Value |
|---|---|---|
| value | any | — |
| type? | string | — |
Returns
UniformNodeTSL function for creating a var node.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| name? | null | string | null |
Returns
VarNodeTSL function for creating a const node.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| name? | null | string | null |
Returns
VarNodeTSL function for creating a var intent node.
Properties
NodeReturns
VarNodeTSL function for creating a varying node.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| name | string | — |
Returns
VaryingNodeComputes a node in the vertex stage.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
Returns
VaryingNodeTSL function for converting a given color node from the current working color space to the given color space.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| targetColorSpace | string | — |
Returns
ColorSpaceNodeTSL function for converting a given color node from the given color space to the current working color space.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| sourceColorSpace | string | — |
Returns
ColorSpaceNodeTSL function for converting a given color node from one color space to another one.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| sourceColorSpace | string | — |
| targetColorSpace | string | — |
Returns
ColorSpaceNodeTSL function for creating a render output node.
| Parameter | Type | Default Value |
|---|---|---|
| color | Node | — |
| toneMapping? | null | number | null |
| outputColorSpace? | null | string | null |
Returns
RenderOutputNodeTSL function for creating a tone mapping node.
| Parameter | Type | Default Value |
|---|---|---|
| mapping | number | — |
| exposure | any | — |
| color | any | — |
Returns
ToneMappingNode<vec3>TSL object that represents the global tone mapping exposure of the renderer.
Type
RendererReferenceNode<vec3>TSL function for creating a compute kernel node.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| workgroupSize? | Array<number> | [64] |
Returns
ComputeNodeTSL function for creating a compute node.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| count | number | Array<number> | — |
| workgroupSize? | Array<number> | [64 |
Returns
ComputeNodeTSL function for creating a conditional node.
| Parameter | Type | Default Value |
|---|---|---|
| condNode | Node | — |
| ifNode | Node | — |
| elseNode? | Node | — |
Returns
ConditionalNodeA small value used to handle floating-point precision errors.
Type
Node<float>Represents infinity.
Type
Node<float>Represents PI.
Type
Node<float>Represents PI * 2. Please use the non-deprecated version TWO_PI.
Type
Node<float>Represents PI * 2.
Type
Node<float>Represents PI / 2.
Type
Node<float>Returns true if all components of x are true.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
Node<bool>Returns true if any components of x are true.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
Node<bool>Converts a quantity in degrees to radians.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeConvert a quantity in radians to degrees.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the natural exponentiation of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns 2 raised to the power of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the natural logarithm of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the base 2 logarithm of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the square root of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the inverse of the square root of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeFinds the nearest integer less than or equal to the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeFinds the nearest integer that is greater than or equal to the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeCalculates the unit vector in the same direction as the original vector.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | — |
Returns
NodeComputes the fractional part of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the sine of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the hyperbolic sine of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the cosine of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the hyperbolic cosine of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the tangent of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the hyperbolic tangent of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the arcsine of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the inverse hyperbolic sine of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the arccosine of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the inverse hyperbolic cosine of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns 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
NodeReturns the inverse hyperbolic tangent of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the absolute value of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeExtracts the sign of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeCalculates the length of a vector.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | — |
Returns
Node<float>Negates the value of the parameter (-x).
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturn 1 minus the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the partial derivative of the parameter with respect to x.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the partial derivative of the parameter with respect to y.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeRounds the parameter to the nearest integer.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the reciprocal of the parameter (1/x).
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeTruncates the parameter, removing the fractional part.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the sum of the absolute derivatives in x and y.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
Returns
NodeReturns the transpose of a matrix.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node<mat2|mat3|mat4> | — |
Returns
NodeReturns the determinant of a matrix.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node<mat2|mat3|mat4> | — |
Returns
Node<float>Returns the inverse of a matrix.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node<mat2|mat3|mat4> | — |
Returns
Node<mat2|mat3|mat4>Returns the least of the given values.
| Parameter | Type | Default Value |
|---|---|---|
| values | ...Node | number | — |
Returns
NodeReturns the greatest of the given values.
| Parameter | Type | Default Value |
|---|---|---|
| values | ...Node | number | — |
Returns
NodeGenerate a step function by comparing two values.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
| y | Node | number | — |
Returns
NodeCalculates 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>Calculates the distance between two points.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node<vec2|vec3|vec4> | — |
| y | Node<vec2|vec3|vec4> | — |
Returns
Node<float>Calculates the absolute difference between two values.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node | number | — |
| y | Node | number | — |
Returns
NodeCalculates the dot product of two vectors.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node<vec2|vec3|vec4> | — |
| y | Node<vec2|vec3|vec4> | — |
Returns
Node<float>Calculates the cross product of two vectors.
| Parameter | Type | Default Value |
|---|---|---|
| x | Node<vec2|vec3> | — |
| y | Node<vec2|vec3> | — |
Returns
Node<float|vec3>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
NodeReturns the square of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | number | Node | — |
Returns
NodeReturns the cube of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | number | Node | — |
Returns
NodeReturns the fourth power of the parameter.
| Parameter | Type | Default Value |
|---|---|---|
| x | number | Node | — |
Returns
NodeTransforms 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
NodeReturns the cube root of a number.
| Parameter | Type | Default Value |
|---|---|---|
| a | number | Node | — |
Returns
NodeCalculate the squared length of a vector.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node<vec2|vec3|vec4> | — |
Returns
Node<float>Linearly interpolates between two values.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | number | — |
| b | Node | number | — |
| t | Node | number | — |
Returns
NodeConstrains a value to lie between two further values.
| Parameter | Type | Default Value |
|---|---|---|
| value | number | Node | — |
| low? | number | Node | 0 |
| high? | number | Node | 1 |
Returns
NodeConstrains a value between 0 and 1.
| Parameter | Type | Default Value |
|---|---|---|
| value | number | Node | — |
Returns
NodeCalculates 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>Performs a Hermite interpolation between two values.
| Parameter | Type | Default Value |
|---|---|---|
| low | Node | number | — |
| high | Node | number | — |
| x | Node | number | — |
Returns
NodeReturns 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>Returns a random value for the given uv.
| Parameter | Type | Default Value |
|---|---|---|
| uv | Node<vec2> | — |
Returns
Node<float>Alias for mix() with a different parameter order.
| Parameter | Type | Default Value |
|---|---|---|
| t | number | Node | — |
| e1 | number | Node | — |
| e2 | number | Node | — |
Returns
NodeAlias for smoothstep() with a different parameter order.
| Parameter | Type | Default Value |
|---|---|---|
| x | number | Node | — |
| low | number | Node | — |
| high | number | Node | — |
Returns
NodeAlias for step() with a different parameter order.
| Parameter | Type | Default Value |
|---|---|---|
| x | number | Node | — |
| edge | number | Node | — |
Returns
NodeType
anyType
anyReturns the addition of two or more value.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
| params | ...Node | — |
Returns
OperatorNodeReturns the subtraction of two or more value.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
| params | ...Node | — |
Returns
OperatorNodeReturns the multiplication of two or more value.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
| params | ...Node | — |
Returns
OperatorNodeReturns the division of two or more value.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
| params | ...Node | — |
Returns
OperatorNodeComputes the remainder of dividing the first node by the second one.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodeChecks if two nodes are equal.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodeChecks if two nodes are not equal.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodeChecks if the first node is less than the second.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodeChecks if the first node is greater than the second.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodeChecks if the first node is less than or equal to the second.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodeChecks if the first node is greater than or equal to the second.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodePerforms a logical AND operation on multiple nodes.
| Parameter | Type | Default Value |
|---|---|---|
| nodes | ...Node | — |
Returns
OperatorNodePerforms a logical OR operation on multiple nodes.
| Parameter | Type | Default Value |
|---|---|---|
| nodes | ...Node | — |
Returns
OperatorNodePerforms logical NOT on a node.
| Parameter | Type | Default Value |
|---|---|---|
| value | Node | — |
Returns
OperatorNodePerforms logical XOR on two nodes.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodePerforms bitwise AND on two nodes.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodePerforms bitwise NOT on a node.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodePerforms bitwise OR on two nodes.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodePerforms bitwise XOR on two nodes.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodeShifts a node to the left.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodeShifts a node to the right.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNodeIncrements a node by 1.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
Returns
OperatorNodeDecrements a node by 1.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
Returns
OperatorNodeIncrements a node by 1 and returns the previous value.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
Returns
OperatorNodeDecrements a node by 1 and returns the previous value.
| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
Returns
OperatorNode| Parameter | Type | Default Value |
|---|---|---|
| a | Node | — |
| b | Node | — |
Returns
OperatorNode| Parameter | Type | Default Value |
|---|---|---|
| name | any | — |
Returns
void| Parameter | Type | Default Value |
|---|---|---|
| name | any | — |
| nodeElement | any | — |
Returns
void| Parameter | Type | Default Value |
|---|---|---|
| value | any | — |
Returns
boolean| Parameter | Type | Default Value |
|---|---|---|
| value | any | — |
Returns
any| Parameter | Type | Default Value |
|---|---|---|
| jsFunc | any | — |
| nodeType | any | — |
Returns
ShaderNodeInternal| Parameter | Type | Default Value |
|---|---|---|
| val | any | — |
| altType? | null | null |
Returns
any| Parameter | Type | Default Value |
|---|---|---|
| val | any | — |
| altType? | null | null |
Returns
any| Parameter | Type | Default Value |
|---|---|---|
| val | any | — |
| altType? | null | null |
Returns
any| Parameter | Type | Default Value |
|---|---|---|
| val | any | — |
| altType? | null | null |
Returns
any| Parameter | Type | Default Value |
|---|---|---|
| NodeClass | any | — |
| scope? | null | null |
| factor? | null | null |
| settings? | null | null |
Returns
any| Parameter | Type | Default Value |
|---|---|---|
| NodeClass | any | — |
| params | ...Array<any> | — |
Returns
any| Parameter | Type | Default Value |
|---|---|---|
| NodeClass | any | — |
| scope? | null | null |
| factor? | null | null |
| settings? | {} | {} |
Returns
any| Parameter | Type | Default Value |
|---|---|---|
| jsFunc | any | — |
| layout? | null | null |
Returns
() => void| Parameter | Type | Default Value |
|---|---|---|
| stack | any | — |
Returns
voidReturns
anyRepresent a conditional node using if/else statements.
If( condition, function )
.ElseIf( condition, function )
.Else( function )
export {}| Parameter | Type | Default Value |
|---|---|---|
| params | ...any | — |
Returns
StackNodeRepresent a conditional node using switch/case statements.
Switch( value )
.Case( 1, function )
.Case( 2, 3, 4, function )
.Default( function )
export {}| Parameter | Type | Default Value |
|---|---|---|
| params | ...any | — |
Returns
StackNodeAdd the given node to the current stack.
Properties
NodeReturns
NodeType
anyType
anyType
anyType
anyType
anyType
anyType
anyType
anyType
anyType
anyType
anyType
anyType
anyType
anyType
anyType
anyType
anyType
anyType
anyType
any| Parameter | Type | Default Value |
|---|---|---|
| value? | string | |
Returns
ConstNode| Parameter | Type | Default Value |
|---|---|---|
| value | any | — |
Returns
ConstNodeType
any| Parameter | Type | Default Value |
|---|---|---|
| node | any | — |
| types | any | — |
Returns
ConvertNode| Parameter | Type | Default Value |
|---|---|---|
| node | any | — |
| channels | any | — |
Returns
SplitNode| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
Returns
FunctionTSL function for creating a debug node.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| callback? | null | Function | null |
Returns
DebugNodeRepresents a discard shader operation in TSL.
| Parameter | Type | Default Value |
|---|---|---|
| conditional | any | — |
Returns
NodeRepresents a return shader operation in TSL.
Returns
ExpressionNodeThis node allows to remap a node value from one range into another. E.g a value of
0.4 in the range [ 0.3, 0.5 ] should be remapped into the normalized range [ 0, 1 ].
remap takes care of that and converts the original value of 0.4 to 0.5.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| inLowNode | Node | — |
| inHighNode | Node | — |
| outLowNode? | Node | — |
| outHighNode? | Node | — |
Returns
NodeThis node allows to remap a node value from one range into another but with enabled clamping. E.g a value of
0.4 in the range [ 0.3, 0.5 ] should be remapped into the normalized range [ 0, 1 ].
remapClamp takes care of that and converts the original value of 0.4 to 0.5.
| Parameter | Type | Default Value |
|---|---|---|
| node | Node | — |
| inLowNode | Node | — |
| inHighNode | Node | — |
| outLowNode? | null | Node | float( 0 ) |
| outHighNode? | null | Node | float( 1 ) |
Returns
Node