Struct embedded_iconoir::Icon

pub struct Icon<C, Ico>
where
    C: PixelColor,
    Ico: IconoirInternal,
{ /* private fields */ }

Struct to store icon color and properties.

There are two ways to instantiate an icon:

// using constructors on icons (recommended)
let icon = icons::size24px::actions::Download::new(BinaryColor::On);
// using types
let icon: Icon<_, icons::size24px::actions::Download> = Icon::new(BinaryColor::On);

Both result in the same icon (Icon<COLOR, ICON>). Use whichever you prefer.

Full Usage Example

// Import icons and traits
use embedded_iconoir::prelude::*;

// Create an icon
let icon = icons::size24px::actions::Download::new(BinaryColor::On);

// Wrap it in an embedded_graphics image
let image = Image::new(&icon, Point::zero());

// Draw it to a display
image.draw(&mut display).unwrap();

Implementations

impl<C: PixelColor, Ico: IconoirInternal> Icon<C, Ico>

pub fn new(color: C) -> Self

pub fn set_color(&mut self, color: C)

pub fn get_color(&self) -> C

Trait Implementations

impl<C, Ico> Debug for Icon<C, Ico>

where C: PixelColor + Debug, Ico: IconoirInternal + Debug,

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

Formats the value using the given formatter.

impl<C, T> ImageDrawable for Icon<C, T>

where T: IconoirInternal, C: PixelColor,

type Color = C

The color type.

fn draw<D>(&self, target: &mut D) -> Result<(), D::Error>

where D: DrawTarget<Color = Self::Color>,

Draws the entire image to the target.

fn draw_sub_image<D>( &self, target: &mut D, area: &Rectangle ) -> Result<(), D::Error>

where D: DrawTarget<Color = Self::Color>,

Draws a part of the image to the target.

impl<C, T> OriginDimensions for Icon<C, T>

where T: IconoirInternal, C: PixelColor,

fn size(&self) -> Size

Returns the size of the bounding box.