Skip to main content

Gradient

Struct Gradient 

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§

§

impl Gradient

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

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

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

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, ) -> Gradient

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, ) -> Gradient

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

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

Builder method for setting the gradient extend mode.

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

Builder method for setting the interpolation color space.

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

Builder method for setting the interpolation alpha space.

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

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

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

Builder method for setting the color stop collection.

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

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

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

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. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for Gradient

§

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

Formats the value using the given formatter. Read more
§

impl Default for Gradient

§

fn default() -> Gradient

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

impl EncodeExt for Gradient

§

fn encode_into( &self, paints: &mut Vec<EncodedPaint>, transform: Affine, _tint: Option<Tint>, ) -> Option<Paint>

Encode the gradient into a paint.

§

impl<'a> From<&'a Gradient> for Brush<ImageBrush<&'a ImageData>, &'a Gradient>

§

fn from( gradient: &'a Gradient, ) -> Brush<ImageBrush<&'a ImageData>, &'a Gradient>

Converts to this type from the input type.
§

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

§

fn from(g: Gradient) -> Brush<I>

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 ==.
1.0.0 (const: unstable) · 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.
§

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
§

impl<T> AnyEq for T
where T: Any + PartialEq,

§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

§

fn as_any(&self) -> &(dyn Any + 'static)

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> NoneValue for T
where T: Default,

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Fruit for T
where T: Send + Downcast,

§

impl<T> MaybeSendSync for T
where T: Send + Sync + ?Sized,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T

§

impl<T> WasmNotSync for T
where T: Sync,