Enum Brush

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

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.

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.

RadialGradient(RadialGradientBrush)

The radial gradient variant of a brush describes a circle variant centered in the middle

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());

pub fn is_opaque(&self) -> bool

Returns true if this brush is fully opaque

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

pub fn brighter(&self, factor: f32) -> Self

Returns a new version of this brush that has the brightness increased by the specified factor. This is done by calling Color::brighter on all the colors of this brush.

pub fn darker(&self, factor: f32) -> Self

Returns a new version of this brush that has the brightness decreased by the specified factor. This is done by calling Color::darker on all the color of this brush.

pub fn transparentize(&self, amount: f32) -> Self

Returns a new version of this brush with the opacity decreased by factor.

The transparency is obtained by multiplying the alpha channel by (1 - factor).

See also Color::transparentize

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

Returns a new version of this brush with the related color’s opacities set to alpha.

Trait Implementations

impl Clone for Brush

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

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

Formats the value using the given formatter.

impl Default for Brush

Construct a brush with transparent color

fn default() -> Self

Returns the “default value” for a type.

impl From<Color> for Brush

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<LinearGradientBrush> for Brush

fn from(value: LinearGradientBrush) -> Self

Converts to this type from the input type.

impl From<RadialGradientBrush> for Brush

fn from(value: RadialGradientBrush) -> Self

Converts to this type from the input type.

impl InterpolatedPropertyValue for Brush

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

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 for Brush

fn eq(&self, other: &Brush) -> 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 StructuralPartialEq for Brush