Struct amethyst_rendy::rendy::wsi::winit::Icon

pub struct Icon { /* fields omitted */ }

An icon used for the window titlebar, taskbar, etc.

Enabling the icon_loading feature provides you with several convenience methods for creating an Icon from any format supported by the image crate.

Methods

impl Icon

pub fn from_rgba(
    rgba: Vec<u8>,
    width: u32,
    height: u32
) -> Result<Icon, BadIcon>

Creates an Icon from 32bpp RGBA data.

The length of rgba must be divisible by 4, and width * height must equal rgba.len() / 4. Otherwise, this will return a BadIcon error.

pub fn from_path<P>(path: P) -> Result<Icon, ImageError> where
    P: AsRef<Path>, 

Loads an Icon from the path of an image on the filesystem.

Requires the icon_loading feature.

pub fn from_reader<R>(
    reader: R,
    format: ImageFormat
) -> Result<Icon, ImageError> where
    R: Seek + BufRead, 

Loads an Icon from anything implementing BufRead and Seek.

Requires the icon_loading feature.

pub fn from_bytes(bytes: &[u8]) -> Result<Icon, ImageError>

Loads an Icon from the unprocessed bytes of an image file. Uses heuristics to determine format.

Requires the icon_loading feature.

pub fn from_bytes_with_format(
    bytes: &[u8],
    format: ImageFormat
) -> Result<Icon, ImageError>

Loads an Icon from the unprocessed bytes of an image.

Requires the icon_loading feature.

Trait Implementations

impl Eq for Icon

impl Clone for Icon

fn clone(&self) -> Icon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Icon> for Icon

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for Icon

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

Formats the value using the given formatter.

impl From<ImageBuffer<Rgba<u8>, Vec<u8>>> for Icon

Requires the icon_loading feature.

fn from(buf: ImageBuffer<Rgba<u8>, Vec<u8>>) -> Icon

Performs the conversion.

impl From<DynamicImage> for Icon

Requires the icon_loading feature.

fn from(image: DynamicImage) -> Icon

Performs the conversion.