Struct Linear

pub struct Linear {
    pub start: Point,
    pub end: Point,
    pub stops: [Option<ColorStop>; 8],
}

Available on crate feature geometry only.

A linear gradient.

Fields

start: Point

The absolute starting position of the gradient.

end: Point

The absolute ending position of the gradient.

stops: [Option<ColorStop>; 8]

[ColorStop]s along the linear gradient direction.

Implementations

impl Linear

pub fn new(start: Point, end: Point) -> Linear

Creates a new Linear builder.

pub fn add_stop(self, offset: f32, color: Color) -> Linear

Adds a new [ColorStop], defined by an offset and a color, to the gradient.

Any offset that is not within 0.0..=1.0 will be silently ignored.

Any stop added after the 8th will be silently ignored.

pub fn add_stops(self, stops: impl IntoIterator<Item = ColorStop>) -> Linear

Adds multiple [ColorStop]s to the gradient.

Any stop added after the 8th will be silently ignored.

pub fn pack(&self) -> Packed

Packs the Gradient for use in shader code.

Trait Implementations

impl Clone for Linear

fn clone(&self) -> Linear

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Linear

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

Formats the value using the given formatter.

impl From<Linear> for Fill

fn from(gradient: Linear) -> Fill

Converts to this type from the input type.

impl From<Linear> for Gradient

fn from(gradient: Linear) -> Gradient

Converts to this type from the input type.

impl PartialEq for Linear

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

impl StructuralPartialEq for Linear