Struct blend2d::gradient::Gradient

#[repr(transparent)]
pub struct Gradient<T: GradientType> { /* fields omitted */ }

A color gradient. It is generic over its kind, see Linear, Radial and Conical.

Methods

impl<T: GradientType> Gradient<T>

pub fn new<R: AsRef<[GradientStop]>>(
    values: &T::ValuesType,
    extend_mode: ExtendMode,
    stops: R,
    m: Option<&Matrix2D>
) -> Self

Creates a new gradient with optional initial stops and an optional transformation Matrix2D.

pub fn new_from_iter<I: IntoIterator<Item = GradientStop>>(
    values: &T::ValuesType,
    extend_mode: ExtendMode,
    stops: I,
    m: Option<&Matrix2D>
) -> Self

Creates a new gradient from an iterator of GradientStops and an optional transformation Matrix2D.

pub fn extend_mode(&self) -> ExtendMode

The ExtendMode of this gradient.

pub fn set_extend_mode(&mut self, mode: ExtendMode)

Sets the gradient's ExtendMode.

pub fn values(&self) -> &T::ValuesType

The value struct of this gradient.

pub fn set_values(&mut self, values: &T::ValuesType)

Sets the value struct of this gradient.

pub fn x0(&self) -> f64

Returns the x0 value of this gradient.

pub fn y0(&self) -> f64

Returns the y0 value of this gradient.

pub fn set_x0(&mut self, val: f64)

Sets the x0 value of this gradient.

pub fn set_y0(&mut self, val: f64)

Sets the y0 value of this gradient.

pub fn matrix(&self) -> &Matrix2D

Returns the transformation matrix.

impl<T: GradientType> Gradient<T>

pub fn reserve(&mut self, n: usize)

Reserves the capacity of gradient stops for at least n stops.

Panics

Panics if blend2d returns an OutOfMemory error.

pub fn try_reserve(&mut self, n: usize) -> Result<(), OutOfMemory>

Reserves the capacity of gradient stops for at least n stops.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of gradient stops to fit the current usage.

pub fn len(&self) -> usize

Returns the number of stops in this gradient.

pub fn capacity(&self) -> usize

Returns the number of stops in this gradient.

pub fn is_empty(&self) -> bool

Returns true if this gradient is empty, in other words if it has no stops.

pub fn stops(&self) -> &[GradientStop]

Returns the gradient stops as an immutable slice.

pub fn remove_stop(&mut self, index: usize)

Removes the stop at the specified index.

pub fn remove_stops<R: RangeBounds<usize>>(&mut self, range: R)

Removes multiple stops indexed by the given range.

pub fn remove_stop_by_offset(&mut self, offset: f64)

Removes the first stop that matches the given offset.

pub fn remove_stops_in_range<R: RangeBounds<f64>>(&mut self, range: R)

Removes a range of stops that lie inside of the given range.

The range specified will always include its upper bound.

pub fn remove_all_stops_by_offset(&mut self, offset: f64)

Removes all stops matching the given offset.

pub fn index_of_stop(&self, offset: f64) -> Option<usize>

Returns the index of of the stop with with the given offset, or None if none exist.

pub fn reset_stops(&mut self)

Clears the stops buffer.

pub fn add_stop(&mut self, stop: GradientStop)

Adds a gradient stop to the buffer.

pub fn add_stop32(&mut self, offset: f64, rgba: u32)

Adds a gradient stop to the buffer.

pub fn add_stop64(&mut self, offset: f64, rgba: u64)

Adds a gradient stop to the buffer.

impl Gradient<Linear>

pub fn new_linear(
    values: &LinearGradientValues,
    extend_mode: ExtendMode,
    stops: &[GradientStop],
    m: Option<&Matrix2D>
) -> Self

pub fn x1(&self) -> f64

Returns the x1 value of this gradient.

pub fn y1(&self) -> f64

Returns the y1 value of this gradient.

pub fn set_x1(&mut self, val: f64)

Sets the x1 value of this gradient.

pub fn set_y1(&mut self, val: f64)

Sets the y1 value of this gradient.

impl Gradient<Radial>

pub fn new_radial(
    values: &RadialGradientValues,
    extend_mode: ExtendMode,
    stops: &[GradientStop],
    m: Option<&Matrix2D>
) -> Self

pub fn x1(&self) -> f64

Returns the x1 value of this gradient.

pub fn y1(&self) -> f64

Returns the y1 value of this gradient.

pub fn r0(&self) -> f64

Returns the r0 value of this gradient.

pub fn set_x1(&mut self, val: f64)

Sets the x1 value of this gradient.

pub fn set_y1(&mut self, val: f64)

Sets the y1 value of this gradient.

pub fn set_r0(&mut self, val: f64)

Sets the r0 value of this gradient.

impl Gradient<Conical>

pub fn new_conical(
    values: &ConicalGradientValues,
    extend_mode: ExtendMode,
    stops: &[GradientStop],
    m: Option<&Matrix2D>
) -> Self

pub fn angle(&self) -> f64

Returns the angle of this gradient.

pub fn set_angle(&mut self, val: f64)

Sets the angle of this gradient.

Trait Implementations

impl<T: GradientType> MatrixTransform for Gradient<T>

fn set_matrix(&mut self, m: &Matrix2D)

Set the transformation matrix of this type to m.

fn reset_matrix(&mut self)

Reset the transformation matrix.

fn translate(&mut self, x: f64, y: f64)

Translate the transformation matrix.

fn translate_point<P: Point>(&mut self, p: &P)

Translate the transformation matrix.

fn scale(&mut self, x: f64, y: f64)

Scale the transformation matrix.

fn scale_point<P: Point>(&mut self, p: &P)

Scale the transformation matrix.

fn skew(&mut self, x: f64, y: f64)

Skew the transformation matrix.

fn skew_point<P: Point>(&mut self, p: &P)

Skew the transformation matrix.

fn rotate(&mut self, angle: f64)

Rotate the transformation matrix.

fn rotate_around(&mut self, angle: f64, x: f64, y: f64)

Rotate the transformation matrix around a point.

fn rotate_around_point<P: Point>(&mut self, angle: f64, p: &P)

Rotate the transformation matrix around a point.

fn transform(&mut self, mat: &Matrix2D)

Transform the transformation matrix.

fn post_translate(&mut self, x: f64, y: f64)

Post-translate the transformation matrix.

fn post_translate_point<P: Point>(&mut self, p: &P)

Post-translate the transformation matrix.

fn post_scale(&mut self, x: f64, y: f64)

Post-scale the transformation matrix.

fn post_scale_point<P: Point>(&mut self, p: &P)

Post-scale the transformation matrix.

fn post_skew(&mut self, x: f64, y: f64)

Post-skew the transformation matrix.

fn post_skew_point<P: Point>(&mut self, p: &P)

Post-skew the transformation matrix.

fn post_rotate(&mut self, angle: f64)

Post-rotate the transformation matrix.

fn post_rotate_around(&mut self, angle: f64, x: f64, y: f64)

Post-rotate the transformation matrix around a point.

fn post_rotate_around_point<P: Point>(&mut self, angle: f64, p: &P)

Post-rotate the transformation matrix around a point.

fn post_transform(&mut self, mat: &Matrix2D)

Post-transform the transformation matrix.

impl From<Gradient<Linear>> for DynamicGradient

fn from(g: LinearGradient) -> Self

Performs the conversion.

impl From<Gradient<Conical>> for DynamicGradient

fn from(g: ConicalGradient) -> Self

Performs the conversion.

impl From<Gradient<Radial>> for DynamicGradient

fn from(g: RadialGradient) -> Self

Performs the conversion.

impl<'a, T: GradientType> From<&'a <T as GradientType>::ValuesType> for Gradient<T>

fn from(v: &T::ValuesType) -> Self

Performs the conversion.

impl<T: GradientType> Drop for Gradient<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: GradientType> PartialEq<Gradient<T>> for Gradient<T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: GradientType> Clone for Gradient<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Default for Gradient<T> where
    T: GradientType,
    T::ValuesType: Default, 

fn default() -> Self

Returns the "default value" for a type.

impl<'a, T: GradientType> IntoIterator for &'a Gradient<T>

type Item = &'a GradientStop

The type of the elements being iterated over.

type IntoIter = Iter<'a, GradientStop>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: GradientType> AsRef<[GradientStop]> for Gradient<T>

fn as_ref(&self) -> &[GradientStop]

Performs the conversion.

impl<T: GradientType> Extend<GradientStop> for Gradient<T>

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = GradientStop>, 

Extends a collection with the contents of an iterator.

impl<T> Debug for Gradient<T> where
    T: GradientType,
    T::ValuesType: Debug, 

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

Formats the value using the given formatter.

impl<T: GradientType> Deref for Gradient<T>

type Target = [GradientStop]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, I> Index<I> for Gradient<T> where
    T: GradientType,
    I: SliceIndex<[GradientStop]>, 

type Output = I::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T: GradientType> Borrow<[GradientStop]> for Gradient<T>

fn borrow(&self) -> &[GradientStop]

Immutably borrows from an owned value.