Struct gdnative::api::ParticlesMaterial

pub struct ParticlesMaterial { /* fields omitted */ }

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

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

Constants

pub const EMISSION_SHAPE_BOX: i64

pub const EMISSION_SHAPE_DIRECTED_POINTS: i64

pub const EMISSION_SHAPE_MAX: i64

pub const EMISSION_SHAPE_POINT: i64

pub const EMISSION_SHAPE_POINTS: i64

pub const EMISSION_SHAPE_SPHERE: i64

pub const FLAG_ALIGN_Y_TO_VELOCITY: i64

pub const FLAG_DISABLE_Z: i64

pub const FLAG_MAX: i64

pub const FLAG_ROTATE_Y: i64

pub const PARAM_ANGLE: i64

pub const PARAM_ANGULAR_VELOCITY: i64

pub const PARAM_ANIM_OFFSET: i64

pub const PARAM_ANIM_SPEED: i64

pub const PARAM_DAMPING: i64

pub const PARAM_HUE_VARIATION: i64

pub const PARAM_INITIAL_LINEAR_VELOCITY: i64

pub const PARAM_LINEAR_ACCEL: i64

pub const PARAM_MAX: i64

pub const PARAM_ORBIT_VELOCITY: i64

pub const PARAM_RADIAL_ACCEL: i64

pub const PARAM_SCALE: i64

pub const PARAM_TANGENTIAL_ACCEL: i64

impl ParticlesMaterial

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

Creates a new instance of this object.

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

pub fn color(&self) -> Color

Each particle's initial color. If the [Particles2D]'s [code]texture[/code] is defined, it will be multiplied by this color. To have particle display color in a [SpatialMaterial] make sure to set [member SpatialMaterial.vertex_color_use_as_albedo] to [code]true[/code].

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

Each particle's color will vary along this [GradientTexture].

pub fn direction(&self) -> Vector3D<f32, UnknownUnit>

Unit vector specifying the particles' emission direction.

pub fn emission_box_extents(&self) -> Vector3D<f32, UnknownUnit>

The box's extents if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_BOX].

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

Particle color will be modulated by color determined by sampling this texture at the same point as the [member emission_point_texture].

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

Particle velocity and rotation will be set by sampling this texture at the same point as the [member emission_point_texture]. Used only in [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.

pub fn emission_point_count(&self) -> i64

The number of emission points if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS].

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

Particles will be emitted at positions determined by sampling this texture at a random position. Used with [constant EMISSION_SHAPE_POINTS] and [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.

pub fn emission_shape(&self) -> EmissionShape

Particles will be emitted inside this region. Use [enum EmissionShape] constants for values.

pub fn emission_sphere_radius(&self) -> f64

The sphere's radius if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_SPHERE].

pub fn flag(&self, flag: i64) -> bool

If [code]true[/code], particles rotate around Y axis by [member angle].

pub fn flatness(&self) -> f64

Amount of [member spread] in Y/Z plane. A value of [code]1[/code] restricts particles to X/Z plane.

pub fn gravity(&self) -> Vector3D<f32, UnknownUnit>

Gravity applied to every particle.

pub fn lifetime_randomness(&self) -> f64

Particle lifetime randomness ratio.

pub fn param(&self, param: i64) -> f64

Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.

pub fn param_randomness(&self, param: i64) -> f64

Tangential acceleration randomness ratio.

pub fn param_texture(&self, param: i64) -> Option<Ref<Texture, Shared>>

Each particle's tangential acceleration will vary along this [CurveTexture].

pub fn spread(&self) -> f64

Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Applied to X/Z plane and Y/Z planes.

pub fn trail_color_modifier(&self) -> Option<Ref<GradientTexture, Shared>>

Trail particles' color will vary along this [GradientTexture].

pub fn trail_divisor(&self) -> i64

Emitter will emit [code]amount[/code] divided by [code]trail_divisor[/code] particles. The remaining particles will be used as trail(s).

pub fn trail_size_modifier(&self) -> Option<Ref<CurveTexture, Shared>>

Trail particles' size will vary along this [CurveTexture].

pub fn set_color(&self, color: Color)

Each particle's initial color. If the [Particles2D]'s [code]texture[/code] is defined, it will be multiplied by this color. To have particle display color in a [SpatialMaterial] make sure to set [member SpatialMaterial.vertex_color_use_as_albedo] to [code]true[/code].

pub fn set_color_ramp(&self, ramp: impl AsArg<Texture>)

Each particle's color will vary along this [GradientTexture].

pub fn set_direction(&self, degrees: Vector3D<f32, UnknownUnit>)

Unit vector specifying the particles' emission direction.

pub fn set_emission_box_extents(&self, extents: Vector3D<f32, UnknownUnit>)

The box's extents if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_BOX].

pub fn set_emission_color_texture(&self, texture: impl AsArg<Texture>)

Particle color will be modulated by color determined by sampling this texture at the same point as the [member emission_point_texture].

pub fn set_emission_normal_texture(&self, texture: impl AsArg<Texture>)

Particle velocity and rotation will be set by sampling this texture at the same point as the [member emission_point_texture]. Used only in [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.

pub fn set_emission_point_count(&self, point_count: i64)

The number of emission points if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS].

pub fn set_emission_point_texture(&self, texture: impl AsArg<Texture>)

Particles will be emitted at positions determined by sampling this texture at a random position. Used with [constant EMISSION_SHAPE_POINTS] and [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.

pub fn set_emission_shape(&self, shape: i64)

Particles will be emitted inside this region. Use [enum EmissionShape] constants for values.

pub fn set_emission_sphere_radius(&self, radius: f64)

The sphere's radius if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_SPHERE].

pub fn set_flag(&self, flag: i64, enable: bool)

If [code]true[/code], particles rotate around Y axis by [member angle].

pub fn set_flatness(&self, amount: f64)

Amount of [member spread] in Y/Z plane. A value of [code]1[/code] restricts particles to X/Z plane.

pub fn set_gravity(&self, accel_vec: Vector3D<f32, UnknownUnit>)

Gravity applied to every particle.

pub fn set_lifetime_randomness(&self, randomness: f64)

Particle lifetime randomness ratio.

pub fn set_param(&self, param: i64, value: f64)

Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.

pub fn set_param_randomness(&self, param: i64, randomness: f64)

Tangential acceleration randomness ratio.

pub fn set_param_texture(&self, param: i64, texture: impl AsArg<Texture>)

Each particle's tangential acceleration will vary along this [CurveTexture].

pub fn set_spread(&self, degrees: f64)

Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Applied to X/Z plane and Y/Z planes.

pub fn set_trail_color_modifier(&self, texture: impl AsArg<GradientTexture>)

Trail particles' color will vary along this [GradientTexture].

pub fn set_trail_divisor(&self, divisor: i64)

Emitter will emit [code]amount[/code] divided by [code]trail_divisor[/code] particles. The remaining particles will be used as trail(s).

pub fn set_trail_size_modifier(&self, texture: impl AsArg<CurveTexture>)

Trail particles' size will vary along this [CurveTexture].

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 ParticlesMaterial

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

Formats the value using the given formatter.

impl Deref for ParticlesMaterial

type Target = Material

The resulting type after dereferencing.

fn deref(&self) -> &Material

Dereferences the value.

impl DerefMut for ParticlesMaterial

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

Mutably dereferences the value.

impl GodotObject for ParticlesMaterial

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 ParticlesMaterial

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

impl SubClass<Material> for ParticlesMaterial

impl SubClass<Object> for ParticlesMaterial

impl SubClass<Reference> for ParticlesMaterial

impl SubClass<Resource> for ParticlesMaterial