VisualShaderNode — C# API

class VisualShaderNodeReckfellSharpInherits Resource

Base class for VisualShader nodes. Not related to scene nodes.

A visual shader graph consists of various nodes. Each node in a graph is an individual resource, represented as a rectangular box containing a title and several related properties. Each node can also be connected to other nodes through their connection ports in order to control the shader's flow.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Properties4

DefaultInputValuesProperty

# DefaultInputValues

C#
public Reckfell.Collections.Array DefaultInputValues { get; set; }

ExpandedOutputPortsProperty

# ExpandedOutputPorts

C#
public Reckfell.Collections.Array ExpandedOutputPorts { get; set; }

LinkedParentGraphFrameProperty

# LinkedParentGraphFrame

C#
public int LinkedParentGraphFrame { get; set; }

Represents the index of the frame this node is linked to. If set to -1 the node is not linked to any frame.

OutputPortForPreviewProperty

# OutputPortForPreview

C#
public int OutputPortForPreview { get; set; }

Sets the output port index which will be showed for preview. If set to -1 no port will be open for preview.

Methods11

ClearDefaultInputValuesvoid

# ClearDefaultInputValues

C#
public void ClearDefaultInputValues();

Clears the default input ports value.

GetDefaultInputPortint

# GetDefaultInputPort

C#
public int GetDefaultInputPort(VisualShaderNode.PortType type);

Returns the input port which should be connected by default when this node is created as a result of dragging a connection from an existing node to the empty space on the graph.

Parameters
Name	Type	Default
`type`	`VisualShaderNode.PortType`	—

Returns int

GetDefaultInputValuesReckfell.Collections.Array

# GetDefaultInputValues

C#
public Reckfell.Collections.Array GetDefaultInputValues();

Returns an Reckfell.Collections.Array containing default values for all of the input ports of the node in the form [index0, value0, index1, value1, ...].

Returns Reckfell.Collections.Array

GetFrameint

# GetFrame

C#
public int GetFrame();

Returns int

GetInputPortDefaultValueVariant

# GetInputPortDefaultValue

C#
public Variant GetInputPortDefaultValue(int port);

Returns the default value of the input port.

Parameters
Name	Type	Default
`port`	`int`	—

Returns Variant

GetOutputPortForPreviewint

# GetOutputPortForPreview

C#
public int GetOutputPortForPreview();

Returns int

RemoveInputPortDefaultValuevoid

# RemoveInputPortDefaultValue

C#
public void RemoveInputPortDefaultValue(int port);

Removes the default value of the input port.

Parameters
Name	Type	Default
`port`	`int`	—

SetDefaultInputValuesvoid

# SetDefaultInputValues

C#
public void SetDefaultInputValues(Reckfell.Collections.Array values);

Sets the default input ports values using an Reckfell.Collections.Array of the form [index0, value0, index1, value1, ...]. For example: [0, Vector3(0, 0, 0), 1, Vector3(0, 0, 0)].

Parameters
Name	Type	Default
`values`	`Reckfell.Collections.Array`	—

SetFramevoid

# SetFrame

C#
public void SetFrame(int frame);

Parameters
Name	Type	Default
`frame`	`int`	—

SetInputPortDefaultValuevoid

# SetInputPortDefaultValue

C#
public void SetInputPortDefaultValue(int port, Variant value, Variant prevValue = default);

Sets the default value for the selected input port.

Parameters
Name	Type	Default
`port`	`int`	—
`value`	`Variant`	—
`prevValue`	`Variant`	`default`

SetOutputPortForPreviewvoid

# SetOutputPortForPreview

C#
public void SetOutputPortForPreview(int port);

Parameters
Name	Type	Default
`port`	`int`	—

VisualShaderNode.PortType

Value	Description
`Boolean = 6`	Boolean type. Translated to [code skip-lint]bool` type in shader code.
`Max = 9`	Represents the size of the `VisualShaderNode.PortType` enum.
`Sampler = 8`	Sampler type. Translated to reference of sampler uniform in shader code. Can only be used for input ports in non-uniform nodes.
`Scalar = 0`	Floating-point scalar. Translated to [code skip-lint]float` type in shader code.
`ScalarInt = 1`	Integer scalar. Translated to [code skip-lint]int` type in shader code.
`ScalarUint = 2`	Unsigned integer scalar. Translated to [code skip-lint]uint` type in shader code.
`Transform = 7`	Transform type. Translated to [code skip-lint]mat4` type in shader code.
`Vector2D = 3`	2D vector of floating-point values. Translated to [code skip-lint]vec2` type in shader code.
`Vector3D = 4`	3D vector of floating-point values. Translated to [code skip-lint]vec3` type in shader code.
`Vector4D = 5`	4D vector of floating-point values. Translated to [code skip-lint]vec4` type in shader code.