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

```rust use iconwriter::{Ico, SourceImage, Icon}; use iconwriter::Error as IconError;

fn example() -> Result<(), IconError> { let icon = Ico::new(); match SourceImage::frompath("image.svg") { Some(img) => icon.addentry(resample::linear, &img, 32), None => Ok(()) } } ```

Writing to a File

```rust 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:

| OSType | Description | Supported? | |--------|----------------------------------------------|--------------| | ICON | 32×32 1-bit entry | No | | ICN# | 32×32 1-bit entry with 1-bit mask | No | | icm# | 16×12 1-bit entry with 1-bit mask | No | | icm4 | 16×12 4-bit entry | No | | icm8 | 16×12 8-bit entry | No | | ics# | 16×16 1-bit mask | No | | ics4 | 16×16 4-bit entry | No | | ics8 | 16x16 8-bit entry | No | | is32 | 16×16 24-bit entry | Yes | | s8mk | 16x16 8-bit mask | Yes | | icl4 | 32×32 4-bit entry | No | | icl8 | 32×32 8-bit entry | No | | il32 | 32x32 24-bit entry | Yes | | l8mk | 32×32 8-bit mask | Yes | | ich# | 48×48 1-bit mask | No | | ich4 | 48×48 4-bit entry | No | | ich8 | 48×48 8-bit entry | No | | ih32 | 48×48 24-bit entry | Yes | | h8mk | 48×48 8-bit mask | Yes | | it32 | 128×128 24-bit entry | Yes | | t8mk | 128×128 8-bit mask | Yes | | icp4 | 16x16 32-bit png/jp2 entry | png only | | icp5 | 32x32 32-bit png/jp2 entry | png only | | icp6 | 64x64 32-bit png/jp2 entry | png only | | ic07 | 128x128 32-bit png/jp2 entry | png only | | ic08 | 256×256 32-bit png/jp2 entry | png only | | ic09 | 512×512 32-bit png/jp2 entry | png only | | ic10 | 512x512@2x "retina" 32-bit png/jp2 entry | png only | | ic11 | 16x16@2x "retina" 32-bit png/jp2 entry | png only | | ic12 | 32x32@2x "retina" 32-bit png/jp2 entry | png only | | ic13 | 128x128@2x "retina" 32-bit png/jp2 entry | png only | | ic14 | 256x256@2x "retina" 32-bit png/jp2 entry | png only |

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.

| Format | Supported? | |--------|------------------------------------------------------------------------| | png | All supported color types | | jpeg | Baseline and progressive | | gif | Yes | | bmp | Yes | | ico | Yes | | tiff | Baseline(no fax support), lzw, PackBits | | webp | Lossy(Luma channel only) | | pnm | pbm, pgm, ppm, standard pma | | svg | Static SVG Full 1.1 |