VisualShaderNodeIntParameter — C# API

class VisualShaderNodeIntParameterReckfellSharpInherits VisualShaderNodeParameter

A visual shader node for shader parameter (uniform) of type [int].

A VisualShaderNodeParameter of type [int]. Offers additional customization for range of accepted values.

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

Constructors1

VisualShaderNodeIntParameterConstructor

C#
public VisualShaderNodeIntParameter();

Properties7

DefaultValueProperty

# DefaultValue

C#
public int DefaultValue { get; set; }

Default value of this parameter, which will be used if not set externally. VisualShaderNodeIntParameter.DefaultValueEnabled must be enabled; defaults to 0 otherwise.

DefaultValueEnabledProperty

# DefaultValueEnabled

C#
public bool DefaultValueEnabled { get; set; }

If true, the node will have a custom default value.

EnumNamesProperty

# EnumNames

C#
public string[] EnumNames { get; set; }

The names used for the enum select in the editor. VisualShaderNodeIntParameter.Hint must be VisualShaderNodeIntParameter.HintEnum.Enum for this to take effect.

HintProperty

# Hint

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

Range hint of this node. Use it to customize valid parameter range.

MaxProperty

# Max

C#
public int Max { get; set; }

The maximum value this parameter can take. VisualShaderNodeIntParameter.Hint must be either VisualShaderNodeIntParameter.HintEnum.Range or VisualShaderNodeIntParameter.HintEnum.RangeStep for this to take effect.

MinProperty

# Min

C#
public int Min { get; set; }

The minimum value this parameter can take. VisualShaderNodeIntParameter.Hint must be either VisualShaderNodeIntParameter.HintEnum.Range or VisualShaderNodeIntParameter.HintEnum.RangeStep for this to take effect.

StepProperty

# Step

C#
public int Step { get; set; }

The step between parameter's values. Forces the parameter to be a multiple of the given value. VisualShaderNodeIntParameter.Hint must be VisualShaderNodeIntParameter.HintEnum.RangeStep for this to take effect.

Methods15

GetDefaultValueint

# GetDefaultValue

C#
public int GetDefaultValue();

Returns int

GetEnumNamesstring[]

# GetEnumNames

C#
public string[] GetEnumNames();

Returns string[]

GetHintVisualShaderNodeIntParameter.HintEnum

# GetHint

C#
public VisualShaderNodeIntParameter.HintEnum GetHint();

Returns VisualShaderNodeIntParameter.HintEnum

GetMaxint

# GetMax

C#
public int GetMax();

Returns int

GetMinint

# GetMin

C#
public int GetMin();

Returns int

GetStepint

# GetStep

C#
public int GetStep();

Returns int

IsDefaultValueEnabledbool

# IsDefaultValueEnabled

C#
public bool IsDefaultValueEnabled();

Returns bool

SetDefaultValuevoid

# SetDefaultValue

C#
public void SetDefaultValue(int value);

Parameters
Name	Type	Default
`value`	`int`	—

SetDefaultValueEnabledvoid

# SetDefaultValueEnabled

C#
public void SetDefaultValueEnabled(bool enabled);

Parameters
Name	Type	Default
`enabled`	`bool`	—

SetEnumNames2 overloads

# SetEnumNames · 1/2

C#
public void SetEnumNames(ReadOnlySpan<string> names);

Parameters
Name	Type	Default
`names`	`ReadOnlySpan<string>`	—

# SetEnumNames · 2/2

C#
public void SetEnumNames(string[] names);

Parameters
Name	Type	Default
`names`	`string[]`	—

SetHintvoid

# SetHint

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

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

SetMaxvoid

# SetMax

C#
public void SetMax(int value);

Parameters
Name	Type	Default
`value`	`int`	—

SetMinvoid

# SetMin

C#
public void SetMin(int value);

Parameters
Name	Type	Default
`value`	`int`	—

SetStepvoid

# SetStep

C#
public void SetStep(int value);

Parameters
Name	Type	Default
`value`	`int`	—

VisualShaderNodeIntParameter.HintEnum

Value	Description
`Enum = 3`	The parameter uses an enum to associate preset values to names in the editor.
`Max = 4`	Represents the size of the `VisualShaderNodeIntParameter.HintEnum` enum.
`None = 0`	The parameter will not constrain its value.
`Range = 1`	The parameter's value must be within the specified `VisualShaderNodeIntParameter.Min`/`VisualShaderNodeIntParameter.Max` range.
`RangeStep = 2`	The parameter's value must be within the specified range, with the given `VisualShaderNodeIntParameter.Step` between values.