Gradient

Struct Gradient 

Source
pub struct Gradient {
    pub kind: GradientKind,
    pub extend: Extend,
    pub interpolation_cs: ColorSpaceTag,
    pub hue_direction: HueDirection,
    pub interpolation_alpha_space: InterpolationAlphaSpace,
    pub stops: ColorStops,
}
Expand description

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 gradient’s color ramps will be interpolated linearly in this color space between the specified color stops.

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.

§interpolation_alpha_space: InterpolationAlphaSpace

Alpha space to be used for interpolation

§stops: ColorStops

Color stop collection.

Implementations§

Source§

impl Gradient

Source

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.

Source

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

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

Source

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.

Source

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.

Source

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

Builder method for setting the gradient extend mode.

Source

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

Builder method for setting the interpolation color space.

Source

pub const fn with_interpolation_alpha_space( self, interpolation_alpha_space: InterpolationAlphaSpace, ) -> Self

Builder method for setting the interpolation alpha space.

Source

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.

Source

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

Builder method for setting the color stop collection.

Source

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

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

Source

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

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

Trait Implementations§

Source§

impl Clone for Gradient

Source§

fn clone(&self) -> Gradient

Returns a duplicate of the value. Read more
1.0.0 · 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 Default for Gradient

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl<I> From<Gradient> for Brush<I, Gradient>

Source§

fn from(g: Gradient) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Gradient

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
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.