Skip to main content

Gradient

Struct Gradient 

Source
pub struct Gradient {
    pub geometry: Geometry,
    pub stops: Arc<[(f64, Color)]>,
    pub space: GradientSpace,
    pub units: GradientUnits,
    pub extend: GradientExtend,
}
Expand description

Shared gradient description retained by paint and validated before preparation.

Fields§

§geometry: Geometry

Finite, nondegenerate shape of the gradient coordinate field.

§stops: Arc<[(f64, Color)]>

Two to 64 ordered stops including positions zero and one; equal positions make hard stops.

§space: GradientSpace

Straight-color interpolation space; sampled output is linear premultiplied RGBA.

§units: GradientUnits

Whether geometry uses local logical units or normalized shape bounds.

§extend: GradientExtend

Coordinate policy before interpolation between the stop colors.

Implementations§

Source§

impl Gradient

Source

pub fn validate(&self) -> Result<(), ValidationError>

Checks ordered endpoint-inclusive stops and finite, nondegenerate geometry.

Source

pub fn position( &self, point: Point, bounds: Rect, ) -> Result<f64, ValidationError>

Converts a local point to an extended normalized coordinate. Object-bounds units require finite positive width and height; validate geometry first.

Source

pub fn color(&self, position: f64) -> [f64; 4]

Interpolates validated stops to linear-premultiplied RGBA at a normalized position. Call Self::validate first and apply coordinate extension before sampling.

Trait Implementations§

Source§

impl Clone for Gradient

Source§

fn clone(&self) -> Self

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

impl Debug for Gradient

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Gradient

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.