Struct gdnative::api::VisualShaderNodeExpression

pub struct VisualShaderNodeExpression { /* fields omitted */ }

core class VisualShaderNodeExpression inherits VisualShaderNodeGroupBase (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

VisualShaderNodeExpression inherits methods from:

• VisualShaderNodeGroupBase
• VisualShaderNode
• Resource
• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl VisualShaderNodeExpression

pub fn new() -> Ref<VisualShaderNodeExpression, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn expression(&self) -> GodotString

An expression in Godot Shading Language, which will be injected at the start of the graph's matching shader function ([code]vertex[/code], [code]fragment[/code], or [code]light[/code]), and thus cannot be used to declare functions, varyings, uniforms, or global constants.

pub fn set_expression(&self, expression: impl Into<GodotString>)

An expression in Godot Shading Language, which will be injected at the start of the graph's matching shader function ([code]vertex[/code], [code]fragment[/code], or [code]light[/code]), and thus cannot be used to declare functions, varyings, uniforms, or global constants.

Methods from Deref<Target = VisualShaderNodeGroupBase>

pub fn add_input_port(&self, id: i64, _type: i64, name: impl Into<GodotString>)

Adds an input port with the specified [code]type[/code] (see [enum VisualShaderNode.PortType]) and [code]name[/code].

pub fn add_output_port(&self, id: i64, _type: i64, name: impl Into<GodotString>)

Adds an output port with the specified [code]type[/code] (see [enum VisualShaderNode.PortType]) and [code]name[/code].

pub fn clear_input_ports(&self)

Removes all previously specified input ports.

pub fn clear_output_ports(&self)

Removes all previously specified output ports.

pub fn get_free_input_port_id(&self) -> i64

Returns a free input port ID which can be used in [method add_input_port].

pub fn get_free_output_port_id(&self) -> i64

Returns a free output port ID which can be used in [method add_output_port].

pub fn get_input_port_count(&self) -> i64

Returns the number of input ports in use. Alternative for [method get_free_input_port_id].

pub fn get_inputs(&self) -> GodotString

Returns a [String] description of the input ports as as colon-separated list using the format [code]id,type,name;[/code] (see [method add_input_port]).

pub fn get_output_port_count(&self) -> i64

Returns the number of output ports in use. Alternative for [method get_free_output_port_id].

pub fn get_outputs(&self) -> GodotString

Returns a [String] description of the output ports as as colon-separated list using the format [code]id,type,name;[/code] (see [method add_output_port]).

pub fn size(&self) -> Vector2D<f32, UnknownUnit>

The size of the node in the visual shader graph.

pub fn has_input_port(&self, id: i64) -> bool

Returns [code]true[/code] if the specified input port exists.

pub fn has_output_port(&self, id: i64) -> bool

Returns [code]true[/code] if the specified output port exists.

pub fn is_valid_port_name(&self, name: impl Into<GodotString>) -> bool

Returns [code]true[/code] if the specified port name does not override an existed port name and is valid within the shader.

pub fn remove_input_port(&self, id: i64)

Removes the specified input port.

pub fn remove_output_port(&self, id: i64)

Removes the specified output port.

pub fn set_input_port_name(&self, id: i64, name: impl Into<GodotString>)

Renames the specified input port.

pub fn set_input_port_type(&self, id: i64, _type: i64)

Sets the specified input port's type (see [enum VisualShaderNode.PortType]).

pub fn set_inputs(&self, inputs: impl Into<GodotString>)

Defines all input ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_input_port]).

pub fn set_output_port_name(&self, id: i64, name: impl Into<GodotString>)

Renames the specified output port.

pub fn set_output_port_type(&self, id: i64, _type: i64)

Sets the specified output port's type (see [enum VisualShaderNode.PortType]).

pub fn set_outputs(&self, outputs: impl Into<GodotString>)

Defines all output ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_output_port]).

pub fn set_size(&self, size: Vector2D<f32, UnknownUnit>)

The size of the node in the visual shader graph.

Trait Implementations

impl Debug for VisualShaderNodeExpression

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

Formats the value using the given formatter.

impl Deref for VisualShaderNodeExpression

type Target = VisualShaderNodeGroupBase

The resulting type after dereferencing.

fn deref(&self) -> &VisualShaderNodeGroupBase

Dereferences the value.

impl DerefMut for VisualShaderNodeExpression

fn deref_mut(&mut self) -> &mut VisualShaderNodeGroupBase

Mutably dereferences the value.

impl GodotObject for VisualShaderNodeExpression

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for VisualShaderNodeExpression

fn construct() -> Ref<VisualShaderNodeExpression, Unique>

impl SubClass<Object> for VisualShaderNodeExpression

impl SubClass<Reference> for VisualShaderNodeExpression

impl SubClass<Resource> for VisualShaderNodeExpression

impl SubClass<VisualShaderNode> for VisualShaderNodeExpression

impl SubClass<VisualShaderNodeExpression> for VisualShaderNodeGlobalExpression

impl SubClass<VisualShaderNodeGroupBase> for VisualShaderNodeExpression