Index · Object → RefCounted → Resource → VisualShaderNode → VisualShaderNodeParameter → VisualShaderNodeTextureParameter

VisualShaderNodeTextureParameter

Performs a uniform texture lookup within the visual shader graph.

Inherited by (5): VisualShaderNodeCubemapParameterVisualShaderNodeTexture2DArrayParameterVisualShaderNodeTexture2DParameterVisualShaderNodeTexture3DParameterVisualShaderNodeTextureParameterTriplanar
Class Description

Performs a lookup operation on the texture provided as a uniform for the shader.

Properties

var color_default: VisualShaderNodeTextureParameter.ColorDefault = 0

Sets the default color if no texture is assigned to the uniform.

var texture_filter: VisualShaderNodeTextureParameter.TextureFilter = 0

Sets the texture filtering mode.

var texture_repeat: VisualShaderNodeTextureParameter.TextureRepeat = 0

Sets the texture repeating mode.

var texture_source: VisualShaderNodeTextureParameter.TextureSource = 0

Sets the texture source mode. Used for reading from the screen, depth, or normal_roughness texture.

var texture_type: VisualShaderNodeTextureParameter.TextureType = 0

Defines the type of data provided by the source texture.

Inherited from VisualShaderNodeParameter (3)
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 TextureType
TYPE_DATA = 0

No hints are added to the uniform declaration.

TYPE_COLOR = 1

Adds source_color as hint to the uniform declaration for proper conversion from nonlinear sRGB encoding to linear encoding.

TYPE_NORMAL_MAP = 2

Adds hint_normal as hint to the uniform declaration, which internally converts the texture for proper usage as normal map.

TYPE_ANISOTROPY = 3

Adds hint_anisotropy as hint to the uniform declaration to use for a flowmap.

TYPE_MAX = 4

Represents the size of the TextureType enum.

enum ColorDefault
COLOR_DEFAULT_WHITE = 0

Defaults to fully opaque white color.

COLOR_DEFAULT_BLACK = 1

Defaults to fully opaque black color.

COLOR_DEFAULT_TRANSPARENT = 2

Defaults to fully transparent black color.

COLOR_DEFAULT_MAX = 3

Represents the size of the ColorDefault enum.

enum TextureFilter
FILTER_DEFAULT = 0

Sample the texture using the filter determined by the node this shader is attached to.

FILTER_NEAREST = 1

The texture filter reads from the nearest pixel only. This makes the texture look pixelated from up close, and grainy from a distance (due to mipmaps not being sampled).

FILTER_LINEAR = 2

The texture filter blends between the nearest 4 pixels. This makes the texture look smooth from up close, and grainy from a distance (due to mipmaps not being sampled).

FILTER_NEAREST_MIPMAP = 3

The texture filter reads from the nearest pixel and blends between the nearest 2 mipmaps (or uses the nearest mipmap if ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter is true). This makes the texture look pixelated from up close, and smooth from a distance.

Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to Camera2D zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels.

FILTER_LINEAR_MIPMAP = 4

The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps (or uses the nearest mipmap if ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter is true). This makes the texture look smooth from up close, and smooth from a distance.

Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to Camera2D zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels.

FILTER_NEAREST_MIPMAP_ANISOTROPIC = 5

The texture filter reads from the nearest pixel and blends between 2 mipmaps (or uses the nearest mipmap if ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter is true) based on the angle between the surface and the camera view. This makes the texture look pixelated from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level.

Note: This texture filter is rarely useful in 2D projects. FILTER_NEAREST_MIPMAP is usually more appropriate in this case.

FILTER_LINEAR_MIPMAP_ANISOTROPIC = 6

The texture filter blends between the nearest 4 pixels and blends between 2 mipmaps (or uses the nearest mipmap if ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter is true) based on the angle between the surface and the camera view. This makes the texture look smooth from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level.

Note: This texture filter is rarely useful in 2D projects. FILTER_LINEAR_MIPMAP is usually more appropriate in this case.

FILTER_MAX = 7

Represents the size of the TextureFilter enum.

enum TextureRepeat
REPEAT_DEFAULT = 0

Sample the texture using the repeat mode determined by the node this shader is attached to.

REPEAT_ENABLED = 1

Texture will repeat normally.

REPEAT_DISABLED = 2

Texture will not repeat.

REPEAT_MAX = 3

Represents the size of the TextureRepeat enum.

enum TextureSource
SOURCE_NONE = 0

The texture source is not specified in the shader.

SOURCE_SCREEN = 1

The texture source is the screen texture which captures all opaque objects drawn this frame.

SOURCE_DEPTH = 2

The texture source is the depth texture from the depth prepass.

SOURCE_NORMAL_ROUGHNESS = 3

The texture source is the normal-roughness buffer from the depth prepass.

SOURCE_MAX = 4

Represents the size of the TextureSource enum.