Struct gdnative::api::ShaderMaterial

pub struct ShaderMaterial { /* fields omitted */ }

core class ShaderMaterial inherits Material (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

ShaderMaterial inherits methods from:

• Material
• 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 ShaderMaterial

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

Creates a new instance of this object.

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

pub fn shader(&self) -> Option<Ref<Shader, Shared>>

The [Shader] program used to render this material.

pub fn get_shader_param(&self, param: impl Into<GodotString>) -> Variant

Returns the current value set for this material of a uniform in the shader.

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

Returns [code]true[/code] if the property identified by [code]name[/code] can be reverted to a default value.

pub fn property_get_revert(&self, name: impl Into<GodotString>) -> Variant

Returns the default value of the material property with given [code]name[/code].

pub fn set_shader(&self, shader: impl AsArg<Shader>)

The [Shader] program used to render this material.

pub fn set_shader_param(
    &self,
    param: impl Into<GodotString>,
    value: impl OwnedToVariant
)

Changes the value set for this material of a uniform in the shader. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly.

Methods from Deref<Target = Material>

pub const RENDER_PRIORITY_MAX: i64

pub const RENDER_PRIORITY_MIN: i64

pub fn next_pass(&self) -> Option<Ref<Material, Shared>>

Sets the [Material] to be used for the next pass. This renders the object again using a different material.
			[b]Note:[/b] only applies to [SpatialMaterial]s and [ShaderMaterial]s with type "Spatial".

pub fn render_priority(&self) -> i64

Sets the render priority for transparent objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects.
			[b]Note:[/b] this only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority).

pub fn set_next_pass(&self, next_pass: impl AsArg<Material>)

Sets the [Material] to be used for the next pass. This renders the object again using a different material.
			[b]Note:[/b] only applies to [SpatialMaterial]s and [ShaderMaterial]s with type "Spatial".

pub fn set_render_priority(&self, priority: i64)

Sets the render priority for transparent objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects.
			[b]Note:[/b] this only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority).

Trait Implementations

impl Debug for ShaderMaterial

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

Formats the value using the given formatter.

impl Deref for ShaderMaterial

type Target = Material

The resulting type after dereferencing.

fn deref(&self) -> &Material

Dereferences the value.

impl DerefMut for ShaderMaterial

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

Mutably dereferences the value.

impl GodotObject for ShaderMaterial

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 ShaderMaterial

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

impl SubClass<Material> for ShaderMaterial

impl SubClass<Object> for ShaderMaterial

impl SubClass<Reference> for ShaderMaterial

impl SubClass<Resource> for ShaderMaterial