IconWriter Lib.

A simple solution for generating .ico and .icns icons. This crate serves as IconBaker CLI's internal library.

Basic usage

use iconwriter::prelude::*;
const n_entrie: usize = 1;
fn main() {
    // Creating the icon
    let mut icon = Icon::ico(n_entries);
    // Importing the source image
    let src_image = SourceImage::from_file("img.jpg").unwrap();
    // Configuring the entry
    let opts = IconOptions::new(
        vec![(32, 32), (64, 64)] /* 32x32 and 64x64 icon */,
        ResamplingFilter::Linear /* Interpolate the image */,
        Crop::Square             /* Square image */
    );
    // Adding the entry
    icon.add_entry(opts, &source_image).unwrap();
}

It is important to note that although the Icon returned by the Icon::ico, Icon::icns, Icon::png_sequece and Icon::new methods has the capacity specified, the Icon will have zero entries.

For an explanation of the difference between length and capacity, see Capacity and reallocation.

Writing to files

use iconwriter::prelude::*;
use std::fs::File;
const n_entries: usize = ...;
fn main() {
    let mut icon = Icon::ico(n_entries);
    /* Process the icon */
    if let Ok(&file) = File::create("myfile.ico") {
        match icon.write(file) {
            Ok(()) => println!("File 'myfile.ico' saved!"),
            Err(_) => println!("An error occured ;-;")
        }
    }
}

Limitations

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

However, the coverage provided by these external dependencies should be more than enought for most use cases.

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

In regards to SVG support, iconwriter uses the nsvg crate for rasterizing .svg files. According to the authors of the crate, "nsvg does not provide all the functionality of NanoSVG yet. Just the bare minimum to create scaled rasters of SVGs. Like NanoSVG, the rasteriser 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 iconwriter is inclined to search for alternatives to nsvg if inquered to. Help would be appreciated.