IconWriter

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.

Overview

An icon consists of a set of entries. An entry is simply an image that has a particular size. IconWriter 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.

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

Examples

General Usage

use iconwriter::{Ico, SourceImage, Icon};
use iconwriter::Error as IconError;
 
fn example() -> Result<(), IconError> {
    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 iconwriter::*;
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 IconWriter nativally supports. Be aware that custum output types can be created using the Icon trait.

• ico
• icns
• png sequence (tar)

Icns Support

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

Image Formats

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