Struct DecorationImage 

pub struct DecorationImage {
    pub image: Option<Arc<ImageData>>,
    pub color_filter: Option<ColorFilter>,
    pub fit: Option<BoxFit>,
    pub alignment: AlignmentGeometry,
    pub center_slice: Option<Rect>,
    pub repeat: ImageRepeat,
    pub match_text_direction: bool,
    pub scale: f32,
    pub opacity: f32,
    pub invert_colors: bool,
    /* private fields */
}

A picture painted as a background, and the reference’s fitting. A picture painted as a box’s background — the reference’s DecorationImage.

The defaults are the reference’s: centred, not repeated, no slice, at its own scale and opacity, fitted by BoxFit::ScaleDown (or BoxFit::Fill with a centre slice) when no fit is named.

The picture is pixels already decoded. One that is still on its way — a network picture, say — is None for now, and paints nothing until it arrives, as the reference’s does.

Fields

image: Option<Arc<ImageData>>

The pixels; None paints nothing.

color_filter: Option<ColorFilter>

A colour filter over the picture, applied before its opacity is.

fit: Option<BoxFit>

How the picture is fitted into the box; None is the reference’s default.

alignment: AlignmentGeometry

Where the picture sits in the spare room, and which part of it a crop keeps.

center_slice: Option<Rect>

The centre slice, in the picture’s units (its pixels over scale): the part that stretches, while the four corners stay their size and the four edges stretch along their length. Fits that crop (BoxFit::None, BoxFit::Cover) have nothing to stretch and are not meant for it.

repeat: ImageRepeat

Whether the picture repeats to fill the box.

match_text_direction: bool

Whether the picture is mirrored when the box reads right to left.

scale: f32

The picture’s pixels per logical pixel: 2.0 draws it at half its pixel size.

opacity: f32

How opaque the picture is, 0..=1.

invert_colors: bool

Whether the picture’s colours are inverted, after the colour filter.

Implementations

impl DecorationImage

pub fn new(image: impl Into<Option<Arc<ImageData>>>) -> DecorationImage

The picture image, centred, at its own size or smaller.

pub fn color_filter(self, filter: ColorFilter) -> DecorationImage

Sets the colour filter.

pub fn fit(self, fit: BoxFit) -> DecorationImage

Sets the fit.

pub fn alignment( self, alignment: impl Into<AlignmentGeometry>, ) -> DecorationImage

Sets where the picture sits.

pub fn center_slice(self, slice: Rect) -> DecorationImage

Sets the centre slice, the part that stretches.

pub fn repeat(self, repeat: ImageRepeat) -> DecorationImage

Sets how the picture repeats.

pub fn match_text_direction(self, matches: bool) -> DecorationImage

Mirrors the picture when the box reads right to left.

pub fn scale(self, scale: f32) -> DecorationImage

Sets the picture’s pixels per logical pixel.

pub fn opacity(self, opacity: f32) -> DecorationImage

Sets the opacity.

pub fn invert_colors(self, invert: bool) -> DecorationImage

Inverts the picture’s colours.

pub fn lerp( a: Option<&DecorationImage>, b: Option<&DecorationImage>, t: f32, ) -> Option<DecorationImage>

The picture t of the way from a to b — the reference’s DecorationImage.lerp. Two different pictures are not blended into a third: both are painted, the first at 1 - t and the second added to it at t. A picture on one side only fades in or out. At 0 and 1 the answer is the end itself.

pub fn pieces( &self, size: Size, rect: Rect, direction: TextDirection, ) -> (Vec<ImagePiece>, bool)

Where each part of the picture lands when it is painted into rect, for a box reading in direction, given the picture’s pixel size — the reference’s paintImage, short of the drawing. Also says whether the parts repeat, which is when they are clipped to rect.

Empty when there is nothing to draw: an empty box, an empty picture, or a fit that leaves no room.

pub fn paint( &self, scene: &mut Scene, rect: Rect, direction: TextDirection, blend: f32, )

Paints the picture into rect, for a box reading in direction, at blend of its opacity — the reference’s DecorationImagePainter.paint, short of the clip, which the decoration adds.

Trait Implementations

impl Clone for DecorationImage

fn clone(&self) -> DecorationImage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecorationImage

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

Formats the value using the given formatter.

impl PartialEq for DecorationImage

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DecorationImage