Struct Gradient

pub struct Gradient {
    pub kind: GradientKind,
    pub extend: Extend,
    pub interpolation_cs: ColorSpaceTag,
    pub hue_direction: HueDirection,
    pub stops: ColorStops,
}

Definition of a gradient that transitions between two or more colors.

Fields

kind: GradientKind

Kind and properties of the gradient.

extend: Extend

Extend mode.

interpolation_cs: ColorSpaceTag

The color space to be used for interpolation.

The colors in the color stops will be converted to this color space.

This defaults to sRGB.

hue_direction: HueDirection

When interpolating within a cylindrical color space, the direction for the hue.

This is interpreted as described in CSS Color Module Level 4 § 12.4.

stops: ColorStops

Color stop collection.

Implementations

impl Gradient

pub fn new_linear(start: impl Into<Point>, end: impl Into<Point>) -> Self

Creates a new linear gradient for the specified start and end points.

pub fn new_radial(center: impl Into<Point>, radius: f32) -> Self

Creates a new radial gradient for the specified center point and radius.

pub fn new_two_point_radial( start_center: impl Into<Point>, start_radius: f32, end_center: impl Into<Point>, end_radius: f32, ) -> Self

Creates a new two point radial gradient for the specified center points and radii.

pub fn new_sweep( center: impl Into<Point>, start_angle: f32, end_angle: f32, ) -> Self

Creates a new sweep gradient for the specified center point, start and end angles.

pub const fn with_extend(self, mode: Extend) -> Self

Builder method for setting the gradient extend mode.

pub const fn with_interpolation_cs( self, interpolation_cs: ColorSpaceTag, ) -> Self

Builder method for setting the interpolation color space.

pub const fn with_hue_direction(self, hue_direction: HueDirection) -> Self

Builder method for setting the hue direction when interpolating within a cylindrical color space.

pub fn with_stops(self, stops: impl ColorStopsSource) -> Self

Builder method for setting the color stop collection.

pub fn with_alpha(self, alpha: f32) -> Self

Returns the gradient with the alpha component for all color stops set to alpha.

pub fn multiply_alpha(self, alpha: f32) -> Self

Returns the gradient with the alpha component for all color stops multiplied by alpha.

Trait Implementations

impl Clone for Gradient

fn clone(&self) -> Gradient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Gradient

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

Formats the value using the given formatter.

impl Default for Gradient

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'a Gradient> for BrushRef<'a>

fn from(gradient: &'a Gradient) -> Self

Converts to this type from the input type.

impl From<Gradient> for Brush

fn from(g: Gradient) -> Self

Converts to this type from the input type.

impl PartialEq for Gradient

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