VisualShaderNodeFloatParameter — C# API

class VisualShaderNodeFloatParameterReckfellSharpInherits VisualShaderNodeParameter

A scalar float parameter to be used within the visual shader graph.

Translated to uniform float in the shader language.

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

Constructors1

VisualShaderNodeFloatParameterConstructor

C#
public VisualShaderNodeFloatParameter();

Properties6

DefaultValueProperty

# DefaultValue

C#
public float DefaultValue { get; set; }

A default value to be assigned within the shader.

DefaultValueEnabledProperty

# DefaultValueEnabled

C#
public bool DefaultValueEnabled { get; set; }

Enables usage of the VisualShaderNodeFloatParameter.DefaultValue.

HintProperty

# Hint

C#
public VisualShaderNodeFloatParameter.HintEnum Hint { get; set; }

A hint applied to the uniform, which controls the values it can take when set through the Inspector.

MaxProperty

# Max

C#
public float Max { get; set; }

Minimum value for range hints. Used if VisualShaderNodeFloatParameter.Hint is set to VisualShaderNodeFloatParameter.HintEnum.Range or VisualShaderNodeFloatParameter.HintEnum.RangeStep.

MinProperty

# Min

C#
public float Min { get; set; }

Maximum value for range hints. Used if VisualShaderNodeFloatParameter.Hint is set to VisualShaderNodeFloatParameter.HintEnum.Range or VisualShaderNodeFloatParameter.HintEnum.RangeStep.

StepProperty

# Step

C#
public float Step { get; set; }

Step (increment) value for the range hint with step. Used if VisualShaderNodeFloatParameter.Hint is set to VisualShaderNodeFloatParameter.HintEnum.RangeStep.

Methods12

GetDefaultValuefloat

# GetDefaultValue

C#
public float GetDefaultValue();

Returns float

GetHintVisualShaderNodeFloatParameter.HintEnum

# GetHint

C#
public VisualShaderNodeFloatParameter.HintEnum GetHint();

Returns VisualShaderNodeFloatParameter.HintEnum

GetMaxfloat

# GetMax

C#
public float GetMax();

Returns float

GetMinfloat

# GetMin

C#
public float GetMin();

Returns float

GetStepfloat

# GetStep

C#
public float GetStep();

Returns float

IsDefaultValueEnabledbool

# IsDefaultValueEnabled

C#
public bool IsDefaultValueEnabled();

Returns bool

SetDefaultValuevoid

# SetDefaultValue

C#
public void SetDefaultValue(float value);

Parameters
Name	Type	Default
`value`	`float`	—

SetDefaultValueEnabledvoid

# SetDefaultValueEnabled

C#
public void SetDefaultValueEnabled(bool enabled);

Parameters
Name	Type	Default
`enabled`	`bool`	—

SetHintvoid

# SetHint

C#
public void SetHint(VisualShaderNodeFloatParameter.HintEnum hint);

Parameters
Name	Type	Default
`hint`	`VisualShaderNodeFloatParameter.HintEnum`	—

SetMaxvoid

# SetMax

C#
public void SetMax(float value);

Parameters
Name	Type	Default
`value`	`float`	—

SetMinvoid

# SetMin

C#
public void SetMin(float value);

Parameters
Name	Type	Default
`value`	`float`	—

SetStepvoid

# SetStep

C#
public void SetStep(float value);

Parameters
Name	Type	Default
`value`	`float`	—

VisualShaderNodeFloatParameter.HintEnum

Value	Description
`Max = 3`	Represents the size of the `VisualShaderNodeFloatParameter.HintEnum` enum.
`None = 0`	No hint used.
`Range = 1`	A range hint for scalar value, which limits possible input values between `VisualShaderNodeFloatParameter.Min` and `VisualShaderNodeFloatParameter.Max`. Translated to `hint_range(min, max)` in shader code.
`RangeStep = 2`	A range hint for scalar value with step, which limits possible input values between `VisualShaderNodeFloatParameter.Min` and `VisualShaderNodeFloatParameter.Max`, with a step (increment) of `VisualShaderNodeFloatParameter.Step`). Translated to `hint_range(min, max, step)` in shader code.