A simple solution for encoding common icon file formats, such as .ico and .icns. This crate is mostly a wrapper for other libraries, unifying existing APIs into a single, cohesive interface.

This crate serves as IconBaker CLI's internal library.

Overview

An icon stores a collection of small images of different sizes. Individial images within the icon are binded to a source image, which is rescaled to fit a particular size using a resampling filter.

Resampling filters are represented by functions that take a source image and a size and return a rescaled raw RGBA buffer. This allows the user of this crate to provide their custom resampling filter. Common resampling filters are provided by the resample module.

Examples

General Usage

use icon_baker::*;
 
fn main() -> icon_baker::Result<()> {
    let icon = Ico::new();

    match SourceImage::from_path("image.svg") {
        Some(img) => icon.add_entry(resample::linear, &img, 32),
        None      => Ok(())
    }
}

Writing to a File

use icon_baker::*;
use std::{io, fs::File};
 
fn main() -> io::Result<()> {
    let icon = PngSequence::new();

    /* Process the icon */

    let file = File::create("ou.icns")?;
    icon.write(file)
}

Limitations

There are two main limitations in this crate: both ICNS and SVG are not fully supported. Due to the use of external dependencies, this crate is not able to fully support the formal specifications of those two file formats.

However, the coverage provided by this external dependencies should be enough for most use cases.

Supported Image Formats

ICNS Support

Icon Baker uses the icns crate for generating .icns files. The supported icon types are specified by the creators of such crate as follows:

SVG Support

IconBaker uses the nsvg crate for rasterizing .svg files. According to the authors of the crate:

Like NanoSVG, the rasterizer only renders flat filled shapes. It is not particularly fast or accurate, but it is a simple way to bake vector graphics into textures.

The author of icon_baker is inclined to search for alternatives to nsvg if inquired to. Help would be appreciated.

License

Licensed under MIT license(LICENSE-MIT or http://opensource.org/licenses/MIT).

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be licensed as above, without any additional terms or conditions.