IconBaker

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. It serves as IconPie's internal library.

Overview

An icon consists of a set of entries. An entry is simply an image that has a particular size. IconBaker simply automates the process of re-scaling pictures and combining them into an icon.

Pictures are scaled using resampling filters, which are represented by functions that take a source image and a size and return a re-scaled image.

This allows the users of this crate to provide their custom resampling filters. Common resampling filters are provided in the resample module.

Examples

General Usage

use icon_baker::*;
 
fn example() -> 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 example() -> io::Result<()> {
    let icon = PngSequence::new();

    /* Process the icon */

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

Support

Icon Formats

This are the output formats IconBaker nativally supports. Be aware that custum output types can be created using the Icon trait.

• ico
• icns
• png sequence (tar)

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:

Image Formats

IconBaker uses image for raster graphics manipulations and resvg with the raqote backend for svg rasterization. Note that raqote requires cmake to build.

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.