Struct VisualShader

#[repr(C)]
pub struct VisualShader { /* private fields */ }

Godot class VisualShader.

Inherits Shader.

Related symbols:

• visual_shader: sidecar module with related enum/flag types
• IVisualShader: virtual methods

See also Godot docs for VisualShader.

Construction

This class is reference-counted. You can create a new instance using VisualShader::new_gd().

Implementations

impl VisualShader

pub const NODE_ID_INVALID: i32 = -1i32

pub const NODE_ID_OUTPUT: i32 = 0i32

pub fn set_mode(&mut self, mode: Mode)

pub fn add_node( &mut self, type_: Type, node: impl AsObjectArg<VisualShaderNode>, position: Vector2, id: i32, )

pub fn get_node(&self, type_: Type, id: i32) -> Option<Gd<VisualShaderNode>>

pub fn set_node_position(&mut self, type_: Type, id: i32, position: Vector2)

pub fn get_node_position(&self, type_: Type, id: i32) -> Vector2

pub fn get_node_list(&self, type_: Type) -> PackedInt32Array

pub fn get_valid_node_id(&self, type_: Type) -> i32

pub fn remove_node(&mut self, type_: Type, id: i32)

pub fn replace_node( &mut self, type_: Type, id: i32, new_class: impl AsArg<StringName>, )

pub fn is_node_connection( &self, type_: Type, from_node: i32, from_port: i32, to_node: i32, to_port: i32, ) -> bool

pub fn can_connect_nodes( &self, type_: Type, from_node: i32, from_port: i32, to_node: i32, to_port: i32, ) -> bool

pub fn connect_nodes( &mut self, type_: Type, from_node: i32, from_port: i32, to_node: i32, to_port: i32, ) -> Error

pub fn disconnect_nodes( &mut self, type_: Type, from_node: i32, from_port: i32, to_node: i32, to_port: i32, )

pub fn connect_nodes_forced( &mut self, type_: Type, from_node: i32, from_port: i32, to_node: i32, to_port: i32, )

pub fn get_node_connections(&self, type_: Type) -> Array<Dictionary>

pub fn set_graph_offset(&mut self, offset: Vector2)

pub fn get_graph_offset(&self) -> Vector2

pub fn attach_node_to_frame(&mut self, type_: Type, id: i32, frame: i32)

pub fn detach_node_from_frame(&mut self, type_: Type, id: i32)

pub fn add_varying( &mut self, name: impl AsArg<GString>, mode: VaryingMode, type_: VaryingType, )

pub fn remove_varying(&mut self, name: impl AsArg<GString>)

pub fn has_varying(&self, name: impl AsArg<GString>) -> bool

Methods from Deref<Target = Shader>

pub fn get_mode(&self) -> Mode

pub fn set_code(&mut self, code: impl AsArg<GString>)

pub fn get_code(&self) -> GString

pub fn set_default_texture_parameter( &mut self, name: impl AsArg<StringName>, texture: impl AsObjectArg<Texture2D>, )

To set the default parameters, use Self::set_default_texture_parameter_ex and its builder methods. See the book for detailed usage instructions.

pub fn set_default_texture_parameter_ex<'a>( &'a mut self, name: impl AsArg<StringName> + 'a, texture: impl AsObjectArg<Texture2D>, ) -> ExSetDefaultTextureParameter<'a>

pub fn get_default_texture_parameter( &self, name: impl AsArg<StringName>, ) -> Option<Gd<Texture2D>>

To set the default parameters, use Self::get_default_texture_parameter_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_default_texture_parameter_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetDefaultTextureParameter<'a>

pub fn get_shader_uniform_list(&mut self) -> Array<Variant>

To set the default parameters, use Self::get_shader_uniform_list_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_shader_uniform_list_ex<'a>( &'a mut self, ) -> ExGetShaderUniformList<'a>

Methods from Deref<Target = Resource>

pub fn set_path(&mut self, path: impl AsArg<GString>)

pub fn take_over_path(&mut self, path: impl AsArg<GString>)

pub fn get_path(&self) -> GString

pub fn set_name(&mut self, name: impl AsArg<GString>)

pub fn get_name(&self) -> GString

pub fn get_rid(&self) -> Rid

pub fn set_local_to_scene(&mut self, enable: bool)

pub fn is_local_to_scene(&self) -> bool

pub fn get_local_scene(&self) -> Option<Gd<Node>>

pub fn setup_local_to_scene(&mut self)

pub fn set_scene_unique_id(&mut self, id: impl AsArg<GString>)

pub fn get_scene_unique_id(&self) -> GString

pub fn emit_changed(&mut self)

pub fn duplicate(&self) -> Option<Gd<Resource>>

To set the default parameters, use Self::duplicate_ex and its builder methods. See the book for detailed usage instructions.

pub fn duplicate_ex<'a>(&'a self) -> ExDuplicate<'a>

Methods from Deref<Target = RefCounted>

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_script(&mut self, script: &Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>

pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>

pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )

pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant

pub fn has_method(&self, method: impl AsArg<StringName>) -> bool

pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32

pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_ex<'a>( &'a mut self, signal: impl AsArg<StringName> + 'a, callable: &'a Callable, ) -> ExConnect<'a>

pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )

pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: impl AsArg<StringName>) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>

pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations

impl Bounds for VisualShader

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for VisualShader

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for VisualShader

type Target = Shader

The resulting type after dereferencing.

fn deref(&self) -> &<VisualShader as Deref>::Target

Dereferences the value.

impl DerefMut for VisualShader

fn deref_mut(&mut self) -> &mut <VisualShader as Deref>::Target

Mutably dereferences the value.

impl GodotClass for VisualShader

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

type Base = Shader

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

fn inherits<U>() -> bool

where U: GodotClass,

Returns whether Self inherits from U.

impl GodotDefault for VisualShader

impl Inherits<Object> for VisualShader

impl Inherits<RefCounted> for VisualShader

impl Inherits<Resource> for VisualShader

impl Inherits<Shader> for VisualShader