Skip to main content

Gradient

Enum Gradient 

Source
#[non_exhaustive]
pub enum Gradient { Linear { angle_deg: f32, stops: Vec<Stop>, }, Radial { cx: f32, cy: f32, radius: f32, stops: Vec<Stop>, }, }
Expand description

Multi-stop gradient pattern.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Linear

Straight-line gradient. angle_deg follows CSS conventions: paints bottom-to-top, 90° left-to-right, etc. Stops are offset-sorted (see Gradient::linear).

Fields

§angle_deg: f32
§stops: Vec<Stop>
§

Radial

Circular gradient. (cx, cy) is the centre in normalised canvas coordinates (0.5, 0.5 is dead-centre). radius is in normalised units of the canvas’s smaller axis. Stops are offset-sorted.

Fields

§cx: f32
§cy: f32
§radius: f32
§stops: Vec<Stop>

Implementations§

Source§

impl Gradient

Source

pub fn linear(angle_deg: f32, stops: impl IntoIterator<Item = Stop>) -> Self

Build a linear gradient. Stops are sorted by offset; duplicates at the same offset keep their original relative order (sort_by is stable).

Source

pub fn radial( cx: f32, cy: f32, radius: f32, stops: impl IntoIterator<Item = Stop>, ) -> Self

Build a radial gradient. Stops are offset-sorted (see Gradient::linear).

Source

pub fn stops(&self) -> &[Stop]

Borrow the gradient’s stop list.

Source

pub fn sample(&self, t: f32) -> Option<u32>

Sample the gradient at a normalised position t ∈ [0, 1] along the gradient axis (for linear) or along the radius (for radial). Out-of-range t clamps to the nearest endpoint stop. Returns None if the gradient has no stops.

Interpolation is linear per channel — the same lerp used by crate::animation::KeyframeValue::Color keyframes — so the behaviour is consistent across the data model.

Trait Implementations§

Source§

impl Clone for Gradient

Source§

fn clone(&self) -> Gradient

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 Gradient

Source§

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

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

impl PartialEq for Gradient

Source§

fn eq(&self, other: &Gradient) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Gradient

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.