Index · Object → RefCounted → Resource → VisualShaderNode → VisualShaderNodeParameter

VisualShaderNodeParameter

A base type for the parameters within the visual shader graph.

Inherited by (10): VisualShaderNodeBooleanParameterVisualShaderNodeColorParameterVisualShaderNodeFloatParameterVisualShaderNodeIntParameterVisualShaderNodeTextureParameterVisualShaderNodeTransformParameterVisualShaderNodeUIntParameterVisualShaderNodeVec2ParameterVisualShaderNodeVec3ParameterVisualShaderNodeVec4Parameter
Class Description

A parameter represents a variable in the shader which is set externally, i.e. from the ShaderMaterial. Parameters are exposed as properties in the ShaderMaterial and can be assigned from the Inspector or from a script.

Properties

var instance_index: int = 0

The index within 0-15 range, which is used to avoid clashes when shader used on multiple materials.

var parameter_name: String = ""

Name of the parameter, by which it can be accessed through the ShaderMaterial properties.

var qualifier: VisualShaderNodeParameter.Qualifier = 0

Defines the scope of the parameter.

Inherited from VisualShaderNode (2)
Inherited from Resource (4)

Methods

Inherited from VisualShaderNode (7)
func set_default_input_values(values: Array) -> void
func set_input_port_default_value(port: int, value: Variant, prev_value: Variant = null) -> void
Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)

Enums & Constants

enum Qualifier
QUAL_NONE = 0

The parameter will be tied to the ShaderMaterial using this shader.

QUAL_GLOBAL = 1

The parameter will use a global value, defined in Project Settings.

QUAL_INSTANCE = 2

The parameter will be tied to the node with attached ShaderMaterial using this shader.

QUAL_INSTANCE_INDEX = 3

The parameter will be tied to the node with attached ShaderMaterial using this shader. Enables setting a instance_index property.

QUAL_MAX = 4

Represents the size of the Qualifier enum.