Emitter

Enum Emitter 

Source
pub enum Emitter {
    Point {
        position: Vec3,
        rate: f32,
        speed: f32,
    },
    Burst {
        position: Vec3,
        count: u32,
        speed: f32,
    },
    Cone {
        position: Vec3,
        direction: Vec3,
        speed: f32,
        spread: f32,
        rate: f32,
    },
    Sphere {
        center: Vec3,
        radius: f32,
        speed: f32,
        rate: f32,
    },
    Box {
        min: Vec3,
        max: Vec3,
        velocity: Vec3,
        rate: f32,
    },
}
Expand description

Particle emitter configuration.

Emitters respawn dead particles at a configurable rate. They run as part of the compute shader, finding dead particle slots and reinitializing them.

§Example

Simulation::<Spark>::new()
    .with_particle_count(10_000)
    .with_emitter(Emitter::Point {
        position: Vec3::ZERO,
        rate: 500.0,
    })
    .with_rule(Rule::Age)
    .with_rule(Rule::Lifetime(2.0))
    .with_rule(Rule::Gravity(9.8))
    .run();

Variants§

§

Point

Emit particles from a single point with random directions.

Simple omnidirectional emitter - particles fly out in all directions.

§Fields

  • position - Spawn location
  • rate - Particles per second
  • speed - Initial speed of particles (default behavior if 0: random 0-0.5)

Fields

§position: Vec3

Spawn position.

§rate: f32

Emission rate (particles per second).

§speed: f32

Initial speed of particles. If 0, uses random velocity.

§

Burst

One-time burst of particles (explosion effect).

Spawns count particles in a single frame, then stops. Useful for explosions, impacts, or other instantaneous effects.

§Fields

  • position - Explosion center
  • count - Number of particles to spawn
  • speed - Initial outward speed
  • triggered - Set to true to fire (resets after burst)

Fields

§position: Vec3

Explosion center.

§count: u32

Number of particles to spawn.

§speed: f32

Initial outward speed.

§

Cone

Directional cone emitter.

Emits particles in a cone shape, useful for fountains, jets, thrusters.

§Fields

  • position - Spawn location
  • direction - Primary emission direction (will be normalized)
  • speed - Initial particle speed
  • spread - Cone half-angle in radians (0 = laser, PI/2 = hemisphere)
  • rate - Particles per second

Fields

§position: Vec3

Spawn position.

§direction: Vec3

Primary emission direction.

§speed: f32

Initial speed of particles.

§spread: f32

Cone half-angle in radians.

§rate: f32

Emission rate (particles per second).

§

Sphere

Spawn particles on a sphere surface.

Particles spawn on the surface and move outward (or inward if speed < 0).

§Fields

  • center - Sphere center
  • radius - Sphere radius
  • speed - Outward speed (negative = inward)
  • rate - Particles per second

Fields

§center: Vec3

Sphere center.

§radius: f32

Sphere radius.

§speed: f32

Outward speed (negative for inward).

§rate: f32

Emission rate (particles per second).

§

Box

Spawn particles within a box volume.

Particles spawn at random positions within the box with optional initial velocity.

§Fields

  • min - Minimum corner of the box
  • max - Maximum corner of the box
  • velocity - Initial velocity for all spawned particles
  • rate - Particles per second

Fields

§min: Vec3

Minimum corner of the box.

§max: Vec3

Maximum corner of the box.

§velocity: Vec3

Initial velocity.

§rate: f32

Emission rate (particles per second).

Implementations§

Source§

impl Emitter

Source

pub fn rate(&self) -> f32

Get the emission rate in particles per second.

For Burst emitters, returns the count as a one-time rate.

Trait Implementations§

Source§

impl Clone for Emitter

Source§

fn clone(&self) -> Emitter

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Emitter

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,