Skip to main content

ImageProps

Struct ImageProps 

Source
pub struct ImageProps {
    pub source: ImageSource,
    pub decorative: bool,
    pub content_mode: ContentMode,
    pub aspect_ratio: Option<f64>,
    pub tint: Option<Color>,
    pub template: bool,
}

Fields§

§source: ImageSource

Which pixels to draw: a staged asset name, encoded bytes, or an already-decoded image (ImageSource, docs/images.md). A name resolves through the backend’s own pipeline (§18.2); bytes and decoded ids need Cap::ImageDecode, and a backend without it draws nothing rather than guessing.

§decorative: bool§content_mode: ContentMode

How the image scales within its frame (default ContentMode::Fit, no stretching).

§aspect_ratio: Option<f64>

Optional width:height ratio the view is constrained to (e.g. 16.0/9.0). None lets the image take its allocated frame.

§tint: Option<Color>

Monochrome tint for a template/vector glyph (docs/vectors.md): backends that can, recolor natively (template rendering on Apple, drawable tint on Android, pixel recolor on GTK); backends that can’t yet ignore it and draw the source colors. None (the default, and every raster image(…)) means “as authored”.

§template: bool

A monochrome template glyph (docs/vectors.md “Template”): with no tint, it draws in the foreground of the surface it sits on — the theme’s label color on the desktops, the cell’s tint on UIKit, currentColor on the web — and follows a theme switch. What a sidebar row’s untinted icon is: a tinted glyph recolors the same way with or without this, and false (the default) draws an untinted glyph as authored. ImagePatch::Tint(None) on a template returns to that foreground, not to the authored colors.

Trait Implementations§

Source§

impl Clone for ImageProps

Source§

fn clone(&self) -> ImageProps

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 ImageProps

Source§

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

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

impl Default for ImageProps

Source§

fn default() -> ImageProps

Returns the “default value” for a type. Read more
Source§

impl PartialEq for ImageProps

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ImageProps

Auto Trait Implementations§

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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Day API ↩ Guides· daybrite.dev