Struct gdnative::api::VisualShaderNodeTexture

pub struct VisualShaderNodeTexture { /* fields omitted */ }

core class VisualShaderNodeTexture inherits VisualShaderNode (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

VisualShaderNodeTexture inherits methods from:

• 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 VisualShaderNodeTexture

Constants

pub const SOURCE_2D_NORMAL: i64

pub const SOURCE_2D_TEXTURE: i64

pub const SOURCE_DEPTH: i64

pub const SOURCE_PORT: i64

pub const SOURCE_SCREEN: i64

pub const SOURCE_TEXTURE: i64

pub const TYPE_COLOR: i64

pub const TYPE_DATA: i64

pub const TYPE_NORMALMAP: i64

impl VisualShaderNodeTexture

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

Creates a new instance of this object.

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

pub fn source(&self) -> Source

Determines the source for the lookup. See [enum Source] for options.

pub fn texture(&self) -> Option<Ref<Texture, Shared>>

The source texture, if needed for the selected [member source].

pub fn texture_type(&self) -> TextureType

Specifies the type of the texture if [member source] is set to [constant SOURCE_TEXTURE]. See [enum TextureType] for options.

pub fn set_source(&self, value: i64)

Determines the source for the lookup. See [enum Source] for options.

pub fn set_texture(&self, value: impl AsArg<Texture>)

The source texture, if needed for the selected [member source].

pub fn set_texture_type(&self, value: i64)

Specifies the type of the texture if [member source] is set to [constant SOURCE_TEXTURE]. See [enum TextureType] for options.

Methods from Deref<Target = VisualShaderNode>

pub const PORT_TYPE_BOOLEAN: i64

pub const PORT_TYPE_MAX: i64

pub const PORT_TYPE_SAMPLER: i64

pub const PORT_TYPE_SCALAR: i64

pub const PORT_TYPE_TRANSFORM: i64

pub const PORT_TYPE_VECTOR: i64

pub fn default_input_values(&self) -> VariantArray<Shared>

Returns an [Array] containing default values for all of the input ports of the node in the form [code][index0, value0, index1, value1, ...][/code].

pub fn get_input_port_default_value(&self, port: i64) -> Variant

Returns the default value of the input [code]port[/code].

pub fn output_port_for_preview(&self) -> i64

Sets the output port index which will be showed for preview. If set to [code]-1[/code] no port will be open for preview.

pub fn set_default_input_values(&self, values: VariantArray<Shared>)

Sets the default input ports values using an [Array] of the form [code][index0, value0, index1, value1, ...][/code]. For example: [code][0, Vector3(0, 0, 0), 1, Vector3(0, 0, 0)][/code].

pub fn set_input_port_default_value(
    &self,
    port: i64,
    value: impl OwnedToVariant
)

Sets the default value for the selected input [code]port[/code].

pub fn set_output_port_for_preview(&self, port: i64)

Sets the output port index which will be showed for preview. If set to [code]-1[/code] no port will be open for preview.

Trait Implementations

impl Debug for VisualShaderNodeTexture

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

Formats the value using the given formatter.

impl Deref for VisualShaderNodeTexture

type Target = VisualShaderNode

The resulting type after dereferencing.

fn deref(&self) -> &VisualShaderNode

Dereferences the value.

impl DerefMut for VisualShaderNodeTexture

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

Mutably dereferences the value.

impl GodotObject for VisualShaderNodeTexture

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 VisualShaderNodeTexture

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

impl SubClass<Object> for VisualShaderNodeTexture

impl SubClass<Reference> for VisualShaderNodeTexture

impl SubClass<Resource> for VisualShaderNodeTexture

impl SubClass<VisualShaderNode> for VisualShaderNodeTexture