Struct ColorStop

pub struct ColorStop {
    pub color: Rgba,
    pub offset: Length,
}

A color stop in a gradient.

Fields

color: Rgba

The color.

offset: Length

Offset point where the color is fully visible.

Relative lengths are calculated on the length of the gradient line. The Length::Default value indicates this color stop is positional.

Implementations

impl ColorStop

pub fn new(color: impl Into<Rgba>, offset: impl Into<Length>) -> Self

New color stop with a defined offset.

pub fn new_positional(color: impl Into<Rgba>) -> Self

New color stop with a undefined offset.

See is_positional for more details.

pub fn is_positional(&self) -> bool

If this color stop offset is resolved relative to the position of the color stop in the stops list.

A Length::Default offset indicates that the color stop is positional.

Layout

When a GradientStops calculates layout, positional stops are resolved like this:

• If it is the first stop, the offset is 0%.
• If it is the last stop, the offset is 100% or the previous stop offset whichever is greater.
• If it is surrounded by two stops with known offsets it is the mid-point between the two stops.
• If there is a sequence of positional stops, they split the available length that is defined by the two stops with known length that define the sequence.

Note

Use ColorStop::is_layout_positional if you already have the layout offset.

pub fn is_layout_positional(layout_offset: f32) -> bool

If a calculated layout offset is positional.

Positive infinity (f32::INFINITY) is used to indicate that the color stop is positional in webrender units.

pub fn layout(&self, axis: LayoutAxis) -> RenderGradientStop

Compute a RenderGradientStop in the current LAYOUT context.

The axis value is used to select the LAYOUT axis inside the offset length.

Note that if this color stop is positional the returned offset is f32::INFINITY. You can use ColorStop::is_layout_positional to check a layout offset.

Trait Implementations

impl Clone for ColorStop

fn clone(&self) -> ColorStop

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorStop

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColorStop

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C: Into<Rgba>, O: Into<Length>> From<(C, O)> for ColorStop

fn from((color, offset): (C, O)) -> Self

Converts to this type from the input type.

impl From<ColorStop> for GradientStop

fn from(color_stop: ColorStop) -> Self

Converts to this type from the input type.

impl From<Hsla> for ColorStop

fn from(positional_color: Hsla) -> Self

Converts to this type from the input type.

impl From<Hsva> for ColorStop

fn from(positional_color: Hsva) -> Self

Converts to this type from the input type.

impl From<Rgba> for ColorStop

fn from(positional_color: Rgba) -> Self

Converts to this type from the input type.

impl<C: Into<Rgba>, O: Into<Length>> IntoVar<ColorStop> for (C, O)

type Var = LocalVar<ColorStop>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

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

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<ColorStop> for Hsla

type Var = LocalVar<ColorStop>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

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

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<ColorStop> for Hsva

type Var = LocalVar<ColorStop>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

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

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<ColorStop> for Rgba

type Var = LocalVar<ColorStop>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

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

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<GradientStop> for ColorStop

type Var = LocalVar<GradientStop>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

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

where Self: Sized,

Converts into BoxedVar<T>.

impl PartialEq for ColorStop

fn eq(&self, other: &ColorStop) -> 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 ColorStop

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Transitionable for ColorStop

fn lerp(self, to: &Self, step: EasingStep) -> Self

Sample the linear interpolation from self -> to by step.

impl<C: Into<Rgba>, O: Into<Length>> IntoValue<ColorStop> for (C, O)

impl IntoValue<ColorStop> for Hsla

impl IntoValue<ColorStop> for Hsva

impl IntoValue<ColorStop> for Rgba

impl IntoValue<GradientStop> for ColorStop

impl StructuralPartialEq for ColorStop