Struct ico::IconImage

pub struct IconImage { /* private fields */ }

A decoded image.

Implementations

impl IconImage

pub fn from_rgba_data(width: u32, height: u32, rgba_data: Vec<u8>) -> IconImage

Creates a new image with the given dimensions and RGBA data. The width and height must be nonzero, and rgba_data must have 4 * width * height bytes and be in row-major order from top to bottom. Panics if the dimensions are out of range or if rgba_data is the wrong length.

pub fn read_png<R: Read>(reader: R) -> Result<IconImage>

Decodes an image from a PNG file. Returns an error if the PNG data is malformed or can’t be decoded.

pub fn write_png<W: Write>(&self, writer: W) -> Result<()>

Encodes the image as a PNG file.

pub fn width(&self) -> u32

Returns the width of the image, in pixels.

pub fn height(&self) -> u32

Returns the height of the image, in pixels.

pub fn cursor_hotspot(&self) -> Option<(u16, u16)>

Returns the coordinates of the cursor hotspot (pixels right from the left edge of the image, and pixels down from the top edge), or None if this image is an icon rather than a cursor.

pub fn set_cursor_hotspot(&mut self, hotspot: Option<(u16, u16)>)

Sets or clears the cursor hotspot coordinates.

pub fn rgba_data(&self) -> &[u8]

Returns the RGBA data for this image, in row-major order from top to bottom.

Trait Implementations

impl Clone for IconImage

fn clone(&self) -> IconImage

Returns a copy of the value.

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

Performs copy-assignment from source.