Struct gdnative::api::CanvasItemMaterial

pub struct CanvasItemMaterial { /* fields omitted */ }

core class CanvasItemMaterial 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

CanvasItemMaterial 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 CanvasItemMaterial

Constants

pub const BLEND_MODE_ADD: i64

pub const BLEND_MODE_MIX: i64

pub const BLEND_MODE_MUL: i64

pub const BLEND_MODE_PREMULT_ALPHA: i64

pub const BLEND_MODE_SUB: i64

pub const LIGHT_MODE_LIGHT_ONLY: i64

pub const LIGHT_MODE_NORMAL: i64

pub const LIGHT_MODE_UNSHADED: i64

impl CanvasItemMaterial

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

Creates a new instance of this object.

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

pub fn blend_mode(&self) -> BlendMode

pub fn light_mode(&self) -> LightMode

pub fn particles_anim_h_frames(&self) -> i64

pub fn particles_anim_loop(&self) -> bool

pub fn particles_anim_v_frames(&self) -> i64

pub fn particles_animation(&self) -> bool

pub fn set_blend_mode(&self, blend_mode: i64)

pub fn set_light_mode(&self, light_mode: i64)

pub fn set_particles_anim_h_frames(&self, frames: i64)

pub fn set_particles_anim_loop(&self, _loop: bool)

pub fn set_particles_anim_v_frames(&self, frames: i64)

pub fn set_particles_animation(&self, particles_anim: bool)

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

pub fn render_priority(&self) -> i64

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

pub fn set_render_priority(&self, priority: i64)

Trait Implementations

impl Debug for CanvasItemMaterial

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

Formats the value using the given formatter.

impl Deref for CanvasItemMaterial

type Target = Material

The resulting type after dereferencing.

fn deref(&self) -> &Material

Dereferences the value.

impl DerefMut for CanvasItemMaterial

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

Mutably dereferences the value.

impl GodotObject for CanvasItemMaterial

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 CanvasItemMaterial

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

impl SubClass<Material> for CanvasItemMaterial

impl SubClass<Object> for CanvasItemMaterial

impl SubClass<Reference> for CanvasItemMaterial

impl SubClass<Resource> for CanvasItemMaterial