Skip to main content

Icon

Struct Icon 

Source
pub struct Icon {
    pub name: &'static str,
    pub kind: Kind,
    pub title: &'static str,
    pub svg: &'static str,
    pub svg_dark: &'static str,
}
Expand description

One icon: its name, kind, title and SVG source for light and dark backgrounds.

Fields§

§name: &'static str

Kebab-case file stem, such as "linear-pattern".

§kind: Kind§title: &'static str

Human-readable name, such as "Linear pattern".

§svg: &'static str

For light backgrounds: dark outline, white to mid-grey faces.

§svg_dark: &'static str

For dark backgrounds: light outline, darker faces, same lighting direction.

Implementations§

Source§

impl Icon

Source

pub fn themed(&self, dark: bool) -> &'static str

The SVG for a light or dark background.

Source

pub fn recolor(&self, palette: &Palette) -> String

The light SVG with every palette colour replaced by the matching slot in palette.

Source

pub fn tinted(&self, color: impl Into<Rgb>) -> String

The light SVG with its ink painted color; any accent detail keeps the light accent. Meant for Kind::is_tintable icons; for other kinds only the outlines change.

Source

pub fn tinted_with( &self, color: impl Into<Rgb>, accent: impl Into<Rgb>, ) -> String

The light SVG with its ink painted color and its accent detail painted accent.

Source

pub fn has_accent(&self) -> bool

Whether the icon has any accent-coloured detail. Apps that tint by multiplying a single-colour raster need a second layer (or a pre-coloured raster) for these.

Trait Implementations§

Source§

impl Clone for Icon

Source§

fn clone(&self) -> Self

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 Copy for Icon

Source§

impl Debug for Icon

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Icon

§

impl RefUnwindSafe for Icon

§

impl Send for Icon

§

impl Sync for Icon

§

impl Unpin for Icon

§

impl UnsafeUnpin for Icon

§

impl UnwindSafe for Icon

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.