Struct GradientStops

pub struct GradientStops {
    pub start: ColorStop,
    pub middle: Vec<GradientStop>,
    pub end: ColorStop,
}

Stops in a gradient.

Use stops! to create a new instance, you can convert from arrays for simpler gradients.

Fields

start: ColorStop

First color stop.

middle: Vec<GradientStop>

Optional stops between start and end.

end: ColorStop

Last color stop.

Implementations

impl GradientStops

pub fn new(start: impl Into<Rgba>, end: impl Into<Rgba>) -> Self

Gradients stops with two colors from start to end.

pub fn from_colors<C: Into<Rgba> + Copy>(colors: &[C]) -> Self

Gradient stops from colors spaced equally.

The stops look like a sequence of positional only color stops but the proportional distribution is pre-calculated.

If less than 2 colors are given, the missing stops are filled with transparent color.

pub fn from_stripes<C: Into<Rgba> + Copy, T: Into<Factor>>( colors: &[C], transition: T, ) -> Self

Gradient stops from colors forming stripes of same length.

The transition parameter controls relative length of the transition between two stripes. 1.0 or 100.pct() is the length of a stripe, set to 0.0 to get hard-lines.

pub fn from_stops<C: Into<ColorStop> + Copy>(stops: &[C]) -> Self

Gradient stops from color stops.

If less than 2 colors are given, the missing stops are filled with transparent color.

pub fn set_alpha<A: Into<RgbaComponent>>(&mut self, alpha: A)

Set the alpha of all colors in the gradient.

pub fn layout_linear( &self, axis: LayoutAxis, extend_mode: ExtendMode, line: &mut PxLine, render_stops: &mut Vec<RenderGradientStop>, )

Computes the linear gradient in the current LAYOUT context.

The axis value selects the layout axis the offsets layout on.

The render_stops content is replaced with stops with offset in the 0..=1 range.

The line points are moved to accommodate input offsets outside the line bounds.

pub fn layout_radial( &self, axis: LayoutAxis, extend_mode: ExtendMode, render_stops: &mut Vec<RenderGradientStop>, )

Computes the layout for a radial gradient.

The render_stops content is replace with stops with offset in the 0..=1 range.

pub fn len(&self) -> usize

Number of stops.

Trait Implementations

impl Clone for GradientStops

fn clone(&self) -> GradientStops

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GradientStops

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GradientStops

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<L: Into<Length> + Copy> From<&[(Hsla, L)]> for GradientStops

fn from(stops: &[(Hsla, L)]) -> Self

GradientStops::from_stops

impl<L: Into<Length> + Copy, const N: usize> From<&[(Hsla, L); N]> for GradientStops

fn from(stops: &[(Hsla, L); N]) -> Self

GradientStops::from_stops

impl<L: Into<Length> + Copy> From<&[(Hsva, L)]> for GradientStops

fn from(stops: &[(Hsva, L)]) -> Self

GradientStops::from_stops

impl<L: Into<Length> + Copy, const N: usize> From<&[(Hsva, L); N]> for GradientStops

fn from(stops: &[(Hsva, L); N]) -> Self

GradientStops::from_stops

impl<L: Into<Length> + Copy> From<&[(Rgba, L)]> for GradientStops

fn from(stops: &[(Rgba, L)]) -> Self

GradientStops::from_stops

impl<L: Into<Length> + Copy, const N: usize> From<&[(Rgba, L); N]> for GradientStops

fn from(stops: &[(Rgba, L); N]) -> Self

GradientStops::from_stops

impl From<&[Hsla]> for GradientStops

fn from(colors: &[Hsla]) -> Self

GradientStops::from_colors

impl<const N: usize> From<&[Hsla; N]> for GradientStops

fn from(colors: &[Hsla; N]) -> Self

GradientStops::from_colors

impl From<&[Hsva]> for GradientStops

fn from(colors: &[Hsva]) -> Self

GradientStops::from_colors

impl<const N: usize> From<&[Hsva; N]> for GradientStops

fn from(colors: &[Hsva; N]) -> Self

GradientStops::from_colors

impl From<&[Rgba]> for GradientStops

fn from(colors: &[Rgba]) -> Self

GradientStops::from_colors

impl<const N: usize> From<&[Rgba; N]> for GradientStops

fn from(colors: &[Rgba; N]) -> Self

GradientStops::from_colors

impl<L: Into<Length> + Copy, const N: usize> From<[(Hsla, L); N]> for GradientStops

fn from(stops: [(Hsla, L); N]) -> Self

GradientStops::from_stops

impl<L: Into<Length> + Copy, const N: usize> From<[(Hsva, L); N]> for GradientStops

fn from(stops: [(Hsva, L); N]) -> Self

GradientStops::from_stops

impl<L: Into<Length> + Copy, const N: usize> From<[(Rgba, L); N]> for GradientStops

fn from(stops: [(Rgba, L); N]) -> Self

GradientStops::from_stops

impl<const N: usize> From<[Hsla; N]> for GradientStops

fn from(colors: [Hsla; N]) -> Self

GradientStops::from_colors

impl<const N: usize> From<[Hsva; N]> for GradientStops

fn from(colors: [Hsva; N]) -> Self

GradientStops::from_colors

impl<const N: usize> From<[Rgba; N]> for GradientStops

fn from(colors: [Rgba; N]) -> Self

GradientStops::from_colors

impl<L: Into<Length> + Copy> IntoVar<GradientStops> for &[(Hsla, L)]

fn into_var(self) -> Self::Var

GradientStops::from_stops

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<L: Into<Length> + Copy, const N: usize> IntoVar<GradientStops> for &[(Hsla, L); N]

fn into_var(self) -> Self::Var

GradientStops::from_stops

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<L: Into<Length> + Copy> IntoVar<GradientStops> for &[(Hsva, L)]

fn into_var(self) -> Self::Var

GradientStops::from_stops

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<L: Into<Length> + Copy, const N: usize> IntoVar<GradientStops> for &[(Hsva, L); N]

fn into_var(self) -> Self::Var

GradientStops::from_stops

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<L: Into<Length> + Copy> IntoVar<GradientStops> for &[(Rgba, L)]

fn into_var(self) -> Self::Var

GradientStops::from_stops

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<L: Into<Length> + Copy, const N: usize> IntoVar<GradientStops> for &[(Rgba, L); N]

fn into_var(self) -> Self::Var

GradientStops::from_stops

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<GradientStops> for &[Hsla]

fn into_var(self) -> Self::Var

GradientStops::from_colors

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<const N: usize> IntoVar<GradientStops> for &[Hsla; N]

fn into_var(self) -> Self::Var

GradientStops::from_colors

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<GradientStops> for &[Hsva]

fn into_var(self) -> Self::Var

GradientStops::from_colors

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<const N: usize> IntoVar<GradientStops> for &[Hsva; N]

fn into_var(self) -> Self::Var

GradientStops::from_colors

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<GradientStops> for &[Rgba]

fn into_var(self) -> Self::Var

GradientStops::from_colors

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<const N: usize> IntoVar<GradientStops> for &[Rgba; N]

fn into_var(self) -> Self::Var

GradientStops::from_colors

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<L: Into<Length> + Copy, const N: usize> IntoVar<GradientStops> for [(Hsla, L); N]

fn into_var(self) -> Self::Var

GradientStops::from_stops

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<L: Into<Length> + Copy, const N: usize> IntoVar<GradientStops> for [(Hsva, L); N]

fn into_var(self) -> Self::Var

GradientStops::from_stops

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<L: Into<Length> + Copy, const N: usize> IntoVar<GradientStops> for [(Rgba, L); N]

fn into_var(self) -> Self::Var

GradientStops::from_stops

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<const N: usize> IntoVar<GradientStops> for [Hsla; N]

fn into_var(self) -> Self::Var

GradientStops::from_colors

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<const N: usize> IntoVar<GradientStops> for [Hsva; N]

fn into_var(self) -> Self::Var

GradientStops::from_colors

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl<const N: usize> IntoVar<GradientStops> for [Rgba; N]

fn into_var(self) -> Self::Var

GradientStops::from_colors

type Var = LocalVar<GradientStops>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl PartialEq for GradientStops

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for GradientStops

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<L: Into<Length> + Copy> IntoValue<GradientStops> for &[(Hsla, L)]

impl<L: Into<Length> + Copy, const N: usize> IntoValue<GradientStops> for &[(Hsla, L); N]

impl<L: Into<Length> + Copy> IntoValue<GradientStops> for &[(Hsva, L)]

impl<L: Into<Length> + Copy, const N: usize> IntoValue<GradientStops> for &[(Hsva, L); N]

impl<L: Into<Length> + Copy> IntoValue<GradientStops> for &[(Rgba, L)]

impl<L: Into<Length> + Copy, const N: usize> IntoValue<GradientStops> for &[(Rgba, L); N]

impl IntoValue<GradientStops> for &[Hsla]

impl<const N: usize> IntoValue<GradientStops> for &[Hsla; N]

impl IntoValue<GradientStops> for &[Hsva]

impl<const N: usize> IntoValue<GradientStops> for &[Hsva; N]

impl IntoValue<GradientStops> for &[Rgba]

impl<const N: usize> IntoValue<GradientStops> for &[Rgba; N]

impl<L: Into<Length> + Copy, const N: usize> IntoValue<GradientStops> for [(Hsla, L); N]

impl<L: Into<Length> + Copy, const N: usize> IntoValue<GradientStops> for [(Hsva, L); N]

impl<L: Into<Length> + Copy, const N: usize> IntoValue<GradientStops> for [(Rgba, L); N]

impl<const N: usize> IntoValue<GradientStops> for [Hsla; N]

impl<const N: usize> IntoValue<GradientStops> for [Hsva; N]

impl<const N: usize> IntoValue<GradientStops> for [Rgba; N]

impl StructuralPartialEq for GradientStops