Skip to main content

Brush

Enum Brush 

Source
pub enum Brush {
    Solid(Color),
    LinearGradient {
        colors: Vec<Color>,
        stops: Option<Vec<f32>>,
        start: Point,
        end: Point,
        tile_mode: TileMode,
    },
    RadialGradient {
        colors: Vec<Color>,
        stops: Option<Vec<f32>>,
        center: Point,
        radius: f32,
        tile_mode: TileMode,
    },
    SweepGradient {
        colors: Vec<Color>,
        stops: Option<Vec<f32>>,
        center: Point,
    },
}
Expand description

Describes how a shape, path or text is filled: a flat color or a gradient. Compose’s Brush.

Variants§

§

Solid(Color)

A single flat color. Compose’s SolidColor.

§

LinearGradient

Colors blend along the line from start to end. Compose’s Brush.linearGradient.

Fields

§colors: Vec<Color>

Colors to blend between, in order, from start to end.

§stops: Option<Vec<f32>>

Positions of colors along the line from start to end, from 0.0 to 1.0; None spaces the colors evenly.

§start: Point

Where the first color is reached, in logical pixels relative to the top-left corner of the painted area. An infinite coordinate means the far edge of that area.

§end: Point

Where the last color is reached, in logical pixels relative to the top-left corner of the painted area. An infinite coordinate means the far edge of that area.

§tile_mode: TileMode

How the gradient continues beyond start and end.

§

RadialGradient

Colors blend with distance from center. Compose’s Brush.radialGradient.

Fields

§colors: Vec<Color>

Colors to blend between, in order, from center outward.

§stops: Option<Vec<f32>>

Positions of colors from 0.0 to 1.0; None spaces the colors evenly.

§center: Point

Gradient center in logical pixels, relative to the top-left corner of the painted area.

§radius: f32

Distance in logical pixels from center at which the last color is reached.

§tile_mode: TileMode

How the gradient continues beyond radius.

§

SweepGradient

Colors blend by angle around center. Compose’s Brush.sweepGradient.

Fields

§colors: Vec<Color>

Colors to blend between, in order.

§stops: Option<Vec<f32>>

Positions of colors from 0.0 to 1.0; None spaces the colors evenly.

§center: Point

Gradient center in logical pixels, relative to the top-left corner of the painted area.

Implementations§

Source§

impl Brush

Source

pub fn solid(color: Color) -> Brush

Creates a brush that paints one flat color.

Source

pub fn linear_gradient(colors: Vec<Color>) -> Brush

Creates a linear gradient that defaults to Compose semantics: start at (0,0), end at (+inf,+inf), and TileMode::Clamp.

Source

pub fn linear_gradient_range( colors: Vec<Color>, start: Point, end: Point, ) -> Brush

Creates a linear gradient that spreads colors evenly from start to end, clamping outside that line.

Source

pub fn linear_gradient_with_tile_mode( colors: Vec<Color>, start: Point, end: Point, tile_mode: TileMode, ) -> Brush

Creates a linear gradient that spreads colors evenly from start to end, repeating or clamping outside that line as tile_mode says.

Source

pub fn linear_gradient_stops( color_stops: Vec<(f32, Color)>, start: Point, end: Point, tile_mode: TileMode, ) -> Brush

Creates a linear gradient from (position, color) pairs, with positions from 0.0 at start to 1.0 at end.

Source

pub fn vertical_gradient(colors: Vec<Color>, start_y: f32, end_y: f32) -> Brush

Creates a vertical gradient that spreads colors evenly from start_y to end_y, clamping outside that range.

Source

pub fn vertical_gradient_tiled( colors: Vec<Color>, start_y: f32, end_y: f32, tile_mode: TileMode, ) -> Brush

Creates a vertical gradient that spreads colors evenly from start_y to end_y, repeating or clamping outside that range as tile_mode says.

Source

pub fn vertical_gradient_default(colors: Vec<Color>) -> Brush

Creates a vertical gradient across the full height of the painted area, clamping at both ends.

Source

pub fn vertical_gradient_stops( color_stops: Vec<(f32, Color)>, start_y: f32, end_y: f32, tile_mode: TileMode, ) -> Brush

Creates a vertical gradient from (position, color) pairs, with positions from 0.0 at start_y to 1.0 at end_y.

Source

pub fn horizontal_gradient( colors: Vec<Color>, start_x: f32, end_x: f32, ) -> Brush

Creates a horizontal gradient that spreads colors evenly from start_x to end_x, clamping outside that range.

Source

pub fn horizontal_gradient_tiled( colors: Vec<Color>, start_x: f32, end_x: f32, tile_mode: TileMode, ) -> Brush

Creates a horizontal gradient that spreads colors evenly from start_x to end_x, repeating or clamping outside that range as tile_mode says.

Source

pub fn horizontal_gradient_default(colors: Vec<Color>) -> Brush

Creates a horizontal gradient across the full width of the painted area, clamping at both ends.

Source

pub fn horizontal_gradient_stops( color_stops: Vec<(f32, Color)>, start_x: f32, end_x: f32, tile_mode: TileMode, ) -> Brush

Creates a horizontal gradient from (position, color) pairs, with positions from 0.0 at start_x to 1.0 at end_x.

Source

pub fn radial_gradient(colors: Vec<Color>, center: Point, radius: f32) -> Brush

Creates a radial gradient that spreads colors evenly from center out to radius, clamping beyond it.

Source

pub fn radial_gradient_tiled( colors: Vec<Color>, center: Point, radius: f32, tile_mode: TileMode, ) -> Brush

Creates a radial gradient that spreads colors evenly from center out to radius, repeating or clamping beyond it as tile_mode says.

Source

pub fn radial_gradient_stops( color_stops: Vec<(f32, Color)>, center: Point, radius: f32, tile_mode: TileMode, ) -> Brush

Creates a radial gradient from (position, color) pairs, with positions from 0.0 at the center to 1.0 at radius.

Source

pub fn sweep_gradient(colors: Vec<Color>, center: Point) -> Brush

Creates a sweep gradient that spreads colors evenly around center.

Source

pub fn sweep_gradient_stops( color_stops: Vec<(f32, Color)>, center: Point, ) -> Brush

Creates a sweep gradient from (position, color) pairs, with positions from 0.0 to 1.0 around center.

Trait Implementations§

Source§

impl Clone for Brush

Source§

fn clone(&self) -> Brush

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 Brush

Source§

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

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

impl From<Color> for Brush

A colour paints as a solid brush wherever a brush is taken, as Compose takes a Color beside each Brush overload.

Source§

fn from(color: Color) -> Brush

Converts to this type from the input type.
Source§

impl PartialEq for Brush

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl RenderHash for Brush

Source§

fn render_hash(&self) -> u64

Returns a hash over exactly the values that change what is drawn. Equal values give equal hashes.
Source§

impl StructuralPartialEq for Brush

Auto Trait Implementations§

§

impl Freeze for Brush

§

impl RefUnwindSafe for Brush

§

impl Send for Brush

§

impl Sync for Brush

§

impl Unpin for Brush

§

impl UnsafeUnpin for Brush

§

impl UnwindSafe for Brush

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.