VisualShaderNodeScalarUniform

Inherits: VisualShaderNodeUniform < VisualShaderNode < Resource < Reference < Object

Properties

float

default_value

0.0

bool

default_value_enabled

false

Hint

hint

0

float

max

1.0

float

min

0.0

float

step

0.1

Enumerations

enum Hint:

  • HINT_NONE = 0 —- No hint used.

  • HINT_RANGE = 1 —- A range hint for scalar value, which limits possible input values between min and max. Translated to hint_range(min, max) in shader code.

  • HINT_RANGE_STEP = 2 —- A range hint for scalar value with step, which limits possible input values between min and max, with a step (increment) of step). Translated to hint_range(min, max, step) in shader code.

  • HINT_MAX = 3 —- Represents the size of the Hint enum.

Property Descriptions

Default

0.0

Setter

set_default_value(value)

Getter

get_default_value()

A default value to be assigned within the shader.

  • bool default_value_enabled

Default

false

Setter

set_default_value_enabled(value)

Getter

is_default_value_enabled()

Enables usage of the default_value.

Default

0

Setter

set_hint(value)

Getter

get_hint()

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

Default

1.0

Setter

set_max(value)

Getter

get_max()

Minimum value for range hints. Used if hint is set to HINT_RANGE or HINT_RANGE_STEP.

Default

0.0

Setter

set_min(value)

Getter

get_min()

Maximum value for range hints. Used if hint is set to HINT_RANGE or HINT_RANGE_STEP.

Default

0.1

Setter

set_step(value)

Getter

get_step()

Step (increment) value for the range hint with step. Used if hint is set to HINT_RANGE_STEP.