Class AddShaderNode

A shader node that performs addition operations between two input values. Supports scalar, Vec2, Vec3, and Vec4 compositions with appropriate component types.

This node creates two input sockets (lhs and rhs) and one output socket, all of the same composition and component type. The node generates shader code for both WebGL (GLSL) and WebGPU (WGSL) backends.

Example

// Create an add node for Vec3 float operations
const addNode = new AddShaderNode(CompositionType.Vec3, ComponentType.Float);

// Connect inputs and get output
const lhsSocket = addNode.getSocketInputLhs();
const rhsSocket = addNode.getSocketInputRhs();
const outputSocket = addNode.getSocketOutput();

Hierarchy (view full)

Constructors

constructor

Properties

__commonPart? __inputConnections __inputs __outputs __shaderFunctionName __shaderNodeUid _tags InvalidObjectUID _shaderNodes currentMaxObjectCount

Accessors

inputConnections objectUID shaderFunctionName shaderNodeUid uniqueName

Methods

_copyFrom addInputConnection getDefaultValue getInput getInputs getOutput getOutputs getShaderCode getShaderFunctionNameDerivative getShaderStage getSocketInputLhs getSocketInputRhs getSocketOutput getTag getTagValue hasTag makeCallStatement matchTag matchTags matchTagsAsFreeStrings removeTag setShaderStage tryToSetTag tryToSetUniqueName unregister validateTagString _reset getRnObject getRnObjectByName getShaderNodeByUid searchByTag

Constructors

constructor

Properties

Protected Optional__commonPart

__commonPart?: CommonShaderPart

Protected__inputConnections

__inputConnections: ShaderNodeInputConnectionType[] = []

Protected__inputs

__inputs: Socket<string, CompositionTypeEnum, ComponentTypeEnum, SocketDefaultValue>[] = []

Protected__outputs

__outputs: Socket<string, CompositionTypeEnum, ComponentTypeEnum, SocketDefaultValue>[] = []

Protected__shaderFunctionName

__shaderFunctionName: string

Protected__shaderNodeUid

__shaderNodeUid: number

_tags

_tags: RnTags = {}

Collection of tags associated with this object

Static ReadonlyInvalidObjectUID

InvalidObjectUID: -1 = -1

Invalid object UID constant

Static_shaderNodes

_shaderNodes: AbstractShaderNode[] = []

StaticcurrentMaxObjectCount

currentMaxObjectCount: number = 0

Current maximum object count for UID generation

Accessors

inputConnections

  • get inputConnections(): ShaderNodeInputConnectionType[]

  • Gets all input connections for this node.

    Returns ShaderNodeInputConnectionType[]

    An array of input connection configurations

objectUID

  • get objectUID(): number

  • Gets the unique object identifier

    Returns number

    The object's UID

shaderFunctionName

shaderNodeUid

uniqueName

  • get uniqueName(): string

  • Gets the unique name of this object

    Returns string

    The unique name string

Methods

_copyFrom

addInputConnection

  • addInputConnection<N, T>(inputShaderNode, outputSocketOfInput, inputSocketOfThis): void

  • Adds an input connection to this node from another shader node. This establishes a data flow connection between the output of one node and the input of this node.

    Type Parameters

    Parameters

    • inputShaderNode: AbstractShaderNode

      The source shader node to connect from

    • outputSocketOfInput: Socket<string, N, T, SocketDefaultValue>

      The output socket of the source node

    • inputSocketOfThis: Socket<string, N, T, SocketDefaultValue>

      The input socket of this node to connect to

    Returns void

getDefaultValue

getInput

getInputs

getOutput

getOutputs

getShaderCode

getShaderFunctionNameDerivative

  • getShaderFunctionNameDerivative(): string

  • Generates the appropriate shader function name derivative based on the current rendering backend and input socket types.

    For WebGPU, this method generates type-specific function names to handle different combinations of composition and component types. For WebGL, it returns the base shader function name.

    Returns string

    The shader function name derivative for the current configuration

    Throws

    Throws an error if the input socket type combination is not implemented

getShaderStage

getSocketInputLhs

getSocketInputRhs

getSocketOutput

getTag

getTagValue

  • getTagValue(tagName): any

  • Retrieves the value associated with a specific tag name

    Parameters

    • tagName: string

      The name of the tag whose value to retrieve

    Returns any

    The tag value, or undefined if the tag doesn't exist

hasTag

  • hasTag(tagName): boolean

  • Checks whether this object has a tag with the specified name

    Parameters

    • tagName: string

      The name of the tag to check for

    Returns boolean

    True if the tag exists (value is not null/undefined), false otherwise

makeCallStatement

  • makeCallStatement(i, shaderNode, functionName, varInputNames, varOutputNames): string

  • Generates a function call statement for this shader node in the final shader code. This method constructs the appropriate function call syntax with proper parameter passing for both WebGL and WebGPU rendering approaches.

    Parameters

    • i: number

      The index of this node in the execution order

    • shaderNode: AbstractShaderNode

      The shader node to generate the call for

    • functionName: string

      The name of the function to call

    • varInputNames: string[][]

      Array of input variable names for each node

    • varOutputNames: string[][]

      Array of output variable names for each node

    Returns string

    The generated function call statement string

matchTag

  • matchTag(tagName, tagValue): boolean

  • Checks if this object has a tag with the specified name and value

    Parameters

    • tagName: string

      The tag name to match

    • tagValue: string

      The tag value to match

    Returns boolean

    True if the object has a matching tag, false otherwise

matchTags

  • matchTags(tags): boolean

  • Checks if this object has all the specified tags with exactly matching values

    Parameters

    • tags: RnTags

      Object containing tag names as keys and expected values

    Returns boolean

    True if all specified tags exist with matching values, false otherwise

matchTagsAsFreeStrings

  • matchTagsAsFreeStrings(stringArray): boolean

  • Checks if the object's combined tag string contains all the provided search strings. This allows for flexible searching within tag names and values.

    Parameters

    • stringArray: string[]

      Array of strings that must all be present in the combined tag string

    Returns boolean

    True if all strings are found in the combined tag string, false otherwise

removeTag

setShaderStage

tryToSetTag

  • tryToSetTag(tag): boolean

  • Attempts to set a tag on this object. If the tag already exists, it will be replaced.

    Parameters

    • tag: Tag

      The tag object containing the name and value to set

    Returns boolean

    True if the tag was successfully set, false if the tag name contains invalid characters

tryToSetUniqueName

  • tryToSetUniqueName(name, toAddNameIfConflict): boolean

  • Attempts to set a unique name for this object

    Parameters

    • name: string

      The desired unique name

    • toAddNameIfConflict: boolean

      If true, appends UID to make name unique when conflicts occur; if false, fails on conflict

    Returns boolean

    True if the name was successfully set, false if there was a conflict and toAddNameIfConflict was false

unregister

validateTagString

  • validateTagString(val): boolean

  • Validates that a tag string contains only allowed characters (alphanumeric and underscore)

    Parameters

    • val: string

      The string to validate

    Returns boolean

    True if the string contains only valid characters, false if it contains invalid characters

Static_reset

StaticgetRnObject

StaticgetRnObjectByName

StaticgetShaderNodeByUid

StaticsearchByTag

  • searchByTag(tag, value): undefined | WeakRef<RnObject>

  • Searches for the first object that has a specific tag with the given value

    Parameters

    • tag: string

      The tag name to search for

    • value: string

      The tag value to match

    Returns undefined | WeakRef<RnObject>

    WeakRef to the first matching object, or undefined if not found

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods