Struct gdnative::api::VisualShader

pub struct VisualShader { /* fields omitted */ }

core class VisualShader inherits Shader (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

VisualShader inherits methods from:

• Shader
• 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 VisualShader

Constants

pub const NODE_ID_INVALID: i64

pub const NODE_ID_OUTPUT: i64

pub const TYPE_FRAGMENT: i64

pub const TYPE_LIGHT: i64

pub const TYPE_MAX: i64

pub const TYPE_VERTEX: i64

impl VisualShader

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

Creates a new instance of this object.

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

pub fn add_node(
    &self,
    _type: i64,
    node: impl AsArg<VisualShaderNode>,
    position: Vector2D<f32, UnknownUnit>,
    id: i64
)

pub fn can_connect_nodes(
    &self,
    _type: i64,
    from_node: i64,
    from_port: i64,
    to_node: i64,
    to_port: i64
) -> bool

pub fn connect_nodes(
    &self,
    _type: i64,
    from_node: i64,
    from_port: i64,
    to_node: i64,
    to_port: i64
) -> Result<(), GodotError>

pub fn connect_nodes_forced(
    &self,
    _type: i64,
    from_node: i64,
    from_port: i64,
    to_node: i64,
    to_port: i64
)

pub fn disconnect_nodes(
    &self,
    _type: i64,
    from_node: i64,
    from_port: i64,
    to_node: i64,
    to_port: i64
)

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

pub fn get_node(
    &self,
    _type: i64,
    id: i64
) -> Option<Ref<VisualShaderNode, Shared>>

pub fn get_node_connections(&self, _type: i64) -> VariantArray<Shared>

pub fn get_node_list(&self, _type: i64) -> TypedArray<i32>

pub fn get_node_position(
    &self,
    _type: i64,
    id: i64
) -> Vector2D<f32, UnknownUnit>

pub fn get_valid_node_id(&self, _type: i64) -> i64

pub fn is_node_connection(
    &self,
    _type: i64,
    from_node: i64,
    from_port: i64,
    to_node: i64,
    to_port: i64
) -> bool

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

pub fn set_graph_offset(&self, offset: Vector2D<f32, UnknownUnit>)

pub fn set_mode(&self, mode: i64)

pub fn set_node_position(
    &self,
    _type: i64,
    id: i64,
    position: Vector2D<f32, UnknownUnit>
)

Methods from Deref<Target = Shader>

pub const MODE_CANVAS_ITEM: i64

pub const MODE_PARTICLES: i64

pub const MODE_SPATIAL: i64

pub fn code(&self) -> GodotString

pub fn custom_defines(&self) -> GodotString

pub fn get_default_texture_param(
    &self,
    param: impl Into<GodotString>
) -> Option<Ref<Texture, Shared>>

pub fn get_mode(&self) -> Mode

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

pub fn set_code(&self, code: impl Into<GodotString>)

pub fn set_custom_defines(&self, custom_defines: impl Into<GodotString>)

pub fn set_default_texture_param(
    &self,
    param: impl Into<GodotString>,
    texture: impl AsArg<Texture>
)

Trait Implementations

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) -> &Shader

Dereferences the value.

impl DerefMut for VisualShader

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

Mutably dereferences the value.

impl GodotObject for VisualShader

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 VisualShader

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

impl SubClass<Object> for VisualShader

impl SubClass<Reference> for VisualShader

impl SubClass<Resource> for VisualShader

impl SubClass<Shader> for VisualShader