Enum sixtyfps::Brush

#[repr(C)]
#[non_exhaustive]
pub enum Brush {
    SolidColor(Color),
    LinearGradient(LinearGradientBrush),
}

A brush is a data structure that is used to describe how a shape, such as a rectangle, path or even text, shall be filled. A brush can also be applied to the outline of a shape, that means the fill of the outline itself.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SolidColor(Color)

The color variant of brush is a plain color that is to be used for the fill.

Tuple Fields of SolidColor

0: Color

LinearGradient(LinearGradientBrush)

The linear gradient variant of a brush describes the gradient stops for a fill where all color stops are along a line that’s rotated by the specified angle.

Tuple Fields of LinearGradient

0: LinearGradientBrush

Implementations

impl Brush

pub fn color(&self) -> Color

If the brush is SolidColor, the contained color is returned. If the brush is a LinearGradient, the color of the first stop is returned.

pub fn is_transparent(&self) -> bool

Returns true if this brush contains a fully transparent color (alpha value is zero)

assert!(Brush::default().is_transparent());
assert!(Brush::SolidColor(Color::from_argb_u8(0, 255, 128, 140)).is_transparent());
assert!(!Brush::SolidColor(Color::from_argb_u8(25, 128, 140, 210)).is_transparent());

Trait Implementations

impl Clone for Brush

pub fn clone(&self) -> Brush

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Brush

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

Formats the value using the given formatter.

impl Default for Brush

Construct a brush with transparent color

pub fn default() -> Brush

Returns the “default value” for a type.

impl From<Color> for Brush

pub fn from(original: Color) -> Brush

Performs the conversion.

impl From<LinearGradientBrush> for Brush

pub fn from(original: LinearGradientBrush) -> Brush

Performs the conversion.

impl InterpolatedPropertyValue for Brush

pub fn interpolate(&self, target_value: &Brush, t: f32) -> Brush

Returns the interpolated value between self and target_value according to the progress parameter t that’s usually between 0 and 1. With certain animation easing curves it may over- or undershoot though.

impl PartialEq<Brush> for Brush

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

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

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

This method tests for !=.

impl StructuralPartialEq for Brush