Struct gdnative_bindings::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<Self, 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

The manner in which a material's rendering is applied to underlying textures.

pub fn light_mode(&self) -> LightMode

The manner in which material reacts to lighting.

pub fn particles_anim_h_frames(&self) -> i64

The number of columns in the spritesheet assigned as [Texture] for a [Particles2D] or [CPUParticles2D].
			[b]Note:[/b] This property is only used and visible in the editor if [member particles_animation] is [code]true[/code].

pub fn particles_anim_loop(&self) -> bool

If [code]true[/code], the particles animation will loop.
			[b]Note:[/b] This property is only used and visible in the editor if [member particles_animation] is [code]true[/code].

pub fn particles_anim_v_frames(&self) -> i64

The number of rows in the spritesheet assigned as [Texture] for a [Particles2D] or [CPUParticles2D].
			[b]Note:[/b] This property is only used and visible in the editor if [member particles_animation] is [code]true[/code].

pub fn particles_animation(&self) -> bool

If [code]true[/code], enable spritesheet-based animation features when assigned to [Particles2D] and [CPUParticles2D] nodes. The [member ParticlesMaterial.anim_speed] or [member CPUParticles2D.anim_speed] should also be set to a positive value for the animation to play.
			This property (and other [code]particles_anim_*[/code] properties that depend on it) has no effect on other types of nodes.

pub fn set_blend_mode(&self, blend_mode: i64)

The manner in which a material's rendering is applied to underlying textures.

pub fn set_light_mode(&self, light_mode: i64)

The manner in which material reacts to lighting.

pub fn set_particles_anim_h_frames(&self, frames: i64)

The number of columns in the spritesheet assigned as [Texture] for a [Particles2D] or [CPUParticles2D].
			[b]Note:[/b] This property is only used and visible in the editor if [member particles_animation] is [code]true[/code].

pub fn set_particles_anim_loop(&self, _loop: bool)

If [code]true[/code], the particles animation will loop.
			[b]Note:[/b] This property is only used and visible in the editor if [member particles_animation] is [code]true[/code].

pub fn set_particles_anim_v_frames(&self, frames: i64)

The number of rows in the spritesheet assigned as [Texture] for a [Particles2D] or [CPUParticles2D].
			[b]Note:[/b] This property is only used and visible in the editor if [member particles_animation] is [code]true[/code].

pub fn set_particles_animation(&self, particles_anim: bool)

If [code]true[/code], enable spritesheet-based animation features when assigned to [Particles2D] and [CPUParticles2D] nodes. The [member ParticlesMaterial.anim_speed] or [member CPUParticles2D.anim_speed] should also be set to a positive value for the animation to play.
			This property (and other [code]particles_anim_*[/code] properties that depend on it) has no effect on other types of nodes.

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 CanvasItemMaterial

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

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<Self, Unique>

impl Sealed for CanvasItemMaterial

impl SubClass<Material> for CanvasItemMaterial

impl SubClass<Object> for CanvasItemMaterial

impl SubClass<Reference> for CanvasItemMaterial

impl SubClass<Resource> for CanvasItemMaterial