Enum Gradient 

pub enum Gradient {
    Linear(Arc<LinearGradient>),
    Radial(Arc<RadialGradient>),
    Conic(Arc<ConicGradient>),
}

A color gradient.

Variants

Linear(Arc<LinearGradient>)

Radial(Arc<RadialGradient>)

Conic(Arc<ConicGradient>)

Implementations

impl Gradient

pub fn linear( args: &mut Args, span: Span, stops: Vec<Spanned<GradientStop>>, space: Spanned<Smart<ColorSpace>>, relative: Smart<RelativeTo>, ) -> SourceResult<Gradient>

Creates a new linear gradient, in which colors transition along a straight line.

pub fn conic( span: Span, stops: Vec<Spanned<GradientStop>>, angle: Angle, space: Spanned<Smart<ColorSpace>>, relative: Smart<RelativeTo>, center: Axes<Ratio>, ) -> SourceResult<Gradient>

Creates a new conic gradient, in which colors change radially around a center point.

pub fn sharp( &self, steps: Spanned<usize>, smoothness: Spanned<Ratio>, ) -> SourceResult<Gradient>

Creates a sharp version of this gradient.

pub fn repeat( &self, repetitions: Spanned<usize>, mirror: bool, ) -> SourceResult<Gradient>

Repeats this gradient a given number of times, optionally mirroring it at every second repetition.

pub fn kind(&self) -> Func

Returns the kind of this gradient.

pub fn stops(&self) -> Vec<GradientStop>

Returns the stops of this gradient.

pub fn space(&self) -> ColorSpace

Returns the mixing space of this gradient.

pub fn relative(&self) -> Smart<RelativeTo>

Returns the relative placement of this gradient.

pub fn angle(&self) -> Option<Angle>

Returns the angle of this gradient.

pub fn center(&self) -> Option<Axes<Ratio>>

Returns the center of this gradient.

pub fn radius(&self) -> Option<Ratio>

Returns the radius of this gradient.

pub fn focal_center(&self) -> Option<Axes<Ratio>>

Returns the focal-center of this gradient.

pub fn focal_radius(&self) -> Option<Ratio>

Returns the focal-radius of this gradient.

pub fn sample(&self, t: RatioOrAngle) -> Color

Sample the gradient at a given position.

pub fn samples(&self, ts: Vec<RatioOrAngle>) -> Array

Samples the gradient at multiple positions at once and returns the results as an array.

impl Gradient

pub fn with_relative(self, relative: RelativeTo) -> Self

Clones this gradient, but with a different relative placement.

pub fn stops_ref(&self) -> &[(Color, Ratio)]

Returns a reference to the stops of this gradient.

pub fn generate_intermediate_stops_for_rgb_interpolation( &self, first: &GradientStop, second: &GradientStop, ) -> impl Iterator<Item = (Color, Ratio)>

Generates additional stops to replicate a gradient in rgb color space interpolation by bisecting

pub fn sample_at( &self, (x, y): (f32, f32), (width, height): (f32, f32), ) -> Color

Samples the gradient at a given position, in the given container. Handles the aspect ratio and angle directly.

pub fn anti_alias(&self) -> bool

Does this gradient need to be anti-aliased?

pub fn unwrap_relative(&self, on_text: bool) -> RelativeTo

Returns the relative placement of this gradient, handling the special case of auto.

pub fn correct_aspect_ratio(angle: Angle, aspect_ratio: Ratio) -> Angle

Corrects this angle for the aspect ratio of a gradient.

This is used specifically for gradients.

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 Eq for Gradient

impl From<Gradient> for Paint

fn from(gradient: Gradient) -> Self

Converts to this type from the input type.

impl FromValue for Gradient

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for Gradient

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoValue for Gradient

fn into_value(self) -> Value

Cast this type into a value.

impl NativeScope for Gradient

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl NativeType for Gradient

const NAME: &'static str = "gradient"

The type’s name.

fn data() -> &'static NativeTypeData

fn ty() -> Type

Get the type for the native Rust 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 Reflect for Gradient

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for Gradient

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl StructuralPartialEq for Gradient