Skip to main content

ParticleGradient

Struct ParticleGradient 

Source
pub struct ParticleGradient(/* private fields */);
Expand description

A piecewise linear RGBA gradient, interpolated in the supplied color space.

use ponko::*;
let g = ParticleGradient::new(vec![(0.0, Color::WHITE), (1.0, Color::BLACK)]);
assert_eq!(g.sample(0.5).r, 0.5);

Implementations§

Source§

impl ParticleGradient

Source

pub fn new(keys: Vec<(f32, Color)>) -> Self

Creates a gradient; panics for empty, unordered or nonfinite keys/colors.

use ponko::*;
let g = ParticleGradient::new(vec![(0.0, Color::WHITE)]);
assert_eq!(g.sample(1.0), Color::WHITE);
Examples found in repository?
examples/particles.rs (lines 20-23)
5fn setup(ctx: &mut Ctx) {
6    ctx.camera3d.position = vec3(0.0, 2.0, 7.0);
7    ctx.camera3d.look_at(vec3(0.0, 1.0, 0.0));
8    ctx.sky.atmosphere = false;
9    let emitter = ParticleEmitter3D::new(ParticleSettings3D {
10        rate: 120.0,
11        burst: 40,
12        lifetime: (0.7, 1.4),
13        speed: (2.0, 4.0),
14        shape: ParticleShape3D::Cone { angle: 0.45 },
15        gravity: vec3(0.0, -3.0, 0.0),
16        drag: 0.2,
17        size: (0.05, 0.13),
18        rotation: (0.0, std::f32::consts::TAU),
19        size_over_life: ParticleCurve::new(vec![(0.0, 0.5), (0.2, 1.0), (1.0, 0.0)]),
20        color_over_life: ParticleGradient::new(vec![
21            (0.0, Color::rgba(1.0, 0.7, 0.2, 1.0)),
22            (1.0, Color::rgba(1.0, 0.1, 0.0, 0.0)),
23        ]),
24        blend: ParticleBlend3D::Additive,
25        max_particles: 512,
26        seed: 42,
27        ..Default::default()
28    });
29    ctx.world.spawn((Transform3D::default(), emitter));
30}
More examples
Hide additional examples
examples/ribbons.rs (lines 26-29)
14fn setup(ctx: &mut Ctx) {
15    ctx.camera3d.position = vec3(0.0, 4.0, 9.0);
16    ctx.camera3d.look_at(vec3(0.0, 0.5, 0.0));
17    let floor_material = ctx.create_material(MaterialDesc::color(Color::hex(0x6B7B58)));
18    let floor_data = MeshData::plane(12.0);
19    let floor = ctx.create_mesh(&floor_data, floor_material);
20    ctx.world.spawn((Transform3D::default(), Model::new(floor)));
21
22    // ANCHOR: trail
23    // A glowing tracer behind a flying ball: a quarter second long, thin at
24    // the end and fading out.
25    let mut tracer = Trail3D::new(0.25, 0.12);
26    tracer.color = ParticleGradient::new(vec![
27        (0.0, Color::rgb(1.0, 0.8, 0.3)),
28        (1.0, Color::rgba(1.0, 0.3, 0.0, 0.0)),
29    ]);
30    tracer.blend = ParticleBlend3D::Additive;
31    let white = ctx.default_material();
32    let ball = ctx.create_mesh(&MeshData::sphere(0.15, 16), white);
33    ctx.world
34        .spawn((Transform3D::default(), Model::new(ball), tracer, Orbiting));
35    // After a teleport: ctx.world.get_mut::<Trail3D>(entity).unwrap().clear();
36    // ANCHOR_END: trail
37
38    // ANCHOR: line
39    // A laser beam 5 m long, from the entity forward.
40    let beam = Line3D {
41        blend: ParticleBlend3D::Additive,
42        ..Line3D::new(vec![Vec3::ZERO, vec3(0.0, 0.0, -5.0)], 0.03, Color::RED)
43    };
44    ctx.world.spawn((Transform3D::at(vec3(-4.0, 1.5, 3.0)), beam));
45    // ANCHOR_END: line
46
47    // ANCHOR: decal
48    // A 1 m scorch mark on the floor at (1, 0, -1): the box is 1 x 1 m wide
49    // and 0.4 m deep, its +Z turned up, so the image is projected down.
50    let up = Quat::from_rotation_x(-std::f32::consts::FRAC_PI_2);
51    let projector = Mat4::from_scale_rotation_translation(vec3(1.0, 1.0, 0.4), up, vec3(1.0, 0.0, -1.0));
52    let mark = floor_data.decal(projector, 0.003);
53    if !mark.indices.is_empty() {
54        let scorch = ctx.create_material(MaterialDesc {
55            blend: Blend::Transparent,
56            ..MaterialDesc::color(Color::rgba(0.05, 0.04, 0.03, 0.8))
57        });
58        let mark = ctx.create_mesh(&mark, scorch);
59        // Drawn where the floor is.
60        ctx.world.spawn((Transform3D::default(), Model::new(mark)));
61    }
62    // A mesh from a glTF file works the same: ctx.load_mesh_data("models/wall.glb")?.decal(..)
63    // ANCHOR_END: decal
64}
Source

pub fn sample(&self, t: f32) -> Color

Evaluates RGBA at normalized age, clamping beyond the keys.

use ponko::*;
assert_eq!(ParticleGradient::default().sample(0.0), Color::WHITE);

Trait Implementations§

Source§

impl Clone for ParticleGradient

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ParticleGradient

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ParticleGradient

Source§

fn default() -> Self

Returns the “default value” for a type. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Component for T
where T: Send + Sync + 'static,

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> Downcast for T
where T: Any,

Source§

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

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

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

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

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

Converts &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)

Converts &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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

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

Source§

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

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> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

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

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> MaybeSync for T
where T: Sync + ?Sized,

Source§

impl<T> MaybeSync for T
where T: Sync + ?Sized,

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

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

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