Struct ico::IconDirEntry

pub struct IconDirEntry { /* fields omitted */ }

One entry in an ICO or CUR file; a single icon or cursor.

Methods

impl IconDirEntry

fn resource_type(&self) -> ResourceType

Returns the type of resource stored in this entry, either an icon or a cursor.

fn width(&self) -> u32

Returns the width of the image, in pixels.

fn height(&self) -> u32

Returns the height of the image, in pixels.

fn bits_per_pixel(&self) -> u16

Returns the bits-per-pixel (color depth) of the image. Returns zero if self.resource_type() == ResourceType::Cursor (since CUR files store hotspot coordinates in place of this field).

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 self.resource_type() != ResourceType::Cursor.

fn is_png(&self) -> bool

Returns true if the image is encoded as a PNG, or false if it is encoded as a BMP.

fn data(&self) -> &[u8]

Returns the raw, encoded image data.

fn decode(&self) -> Result<IconImage>

Decodes this entry into an image. Returns an error if the data is malformed or can't be decoded.

fn encode(image: &IconImage) -> Result<IconDirEntry>

Encodes an image in a new entry. The encoding method is chosen automatically based on the image. Returns an error if the encoding fails.

fn encode_as_bmp(image: &IconImage) -> Result<IconDirEntry>

Encodes an image as a BMP in a new entry. The color depth is determined automatically based on the image. Returns an error if the encoding fails.

fn encode_as_png(image: &IconImage) -> Result<IconDirEntry>

Encodes an image as a PNG in a new entry. The color depth is determined automatically based on the image. Returns an error if the encoding fails.

Trait Implementations

impl Clone for IconDirEntry

fn clone(&self) -> IconDirEntry

Returns a copy of the value.

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

Performs copy-assignment from source.