IconBaker (LIB)
A simple solution for generating .ico
and .icns
icons. This crate serves as IconBaker CLI's internal library.
Intelligent Re-sampling
Icon Baker uses nearest-neighbor re-sampling by default, avoiding blurred edges when upsizing small bitmap sources:
Furthermore, Icon Baker only upsizes bitmap sources on an integer scale and fills the leftover pixels with a transparent border, providing pixel-perfect quality:
You can also specify the sampling filter of each Entry
, by modifying their filter
fields.
Supported Image Formats
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 PAM |
SVG |
Limited(flat filled shapes only) |
Usage
This crate's API revolves around the concept of binding source images to an entry. The following example demonstrates this principle:
use *;
const N_ENTRIES: usize = 1;
Note that the capacity
argument in the Icon::ico
, Icon::icns
, Icon::png_sequence
and Icon::new
methods specifies the expected number of entries in a given Icon
, NOT the number of sizes (since a single entry can contain multiple sizes).
Sampling From Multiple Sources
Let's say you want to customize your icon so that the smaller versions of it are less detailed. IconBaker helps you achieve this by allowing to sample from multiple sources.
You can simply combine separate source images by specifying to which entry they should be assigned:
use *;
const N_ENTRIES: usize = 2;
Note that different Entry
instances do not need to share the same re-sampling options (namely the filter
and crop
fields) and can even share a common source
field.
However, different entries cannot share a common Size
in their sizes
fields. For example, the following program will panic at second call of icon.add_entry()
:
use *;
const N_ENTRIES: usize = 2;
Writing to Files
Writing to files can be easily done by calling the Icon::write
method:
use *;
use File;
/* Const declarations */
Note that the Icon::write
method can also write to instances of any type which implements Write
.
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.
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:
OSType | Description | Supported? |
---|---|---|
ICON |
32×32 1-bit icon | No |
ICN# |
32×32 1-bit icon with 1-bit mask | No |
icm# |
16×12 1-bit icon with 1-bit mask | No |
icm4 |
16×12 4-bit icon | No |
icm8 |
16×12 8-bit icon | No |
ics# |
16×16 1-bit mask | No |
ics4 |
16×16 4-bit icon | No |
ics8 |
16x16 8-bit icon | No |
is32 |
16×16 24-bit icon | Yes |
s8mk |
16x16 8-bit mask | Yes |
icl4 |
32×32 4-bit icon | No |
icl8 |
32×32 8-bit icon | No |
il32 |
32x32 24-bit icon | Yes |
l8mk |
32×32 8-bit mask | Yes |
ich# |
48×48 1-bit mask | No |
ich4 |
48×48 4-bit icon | No |
ich8 |
48×48 8-bit icon | No |
ih32 |
48×48 24-bit icon | Yes |
h8mk |
48×48 8-bit mask | Yes |
it32 |
128×128 24-bit icon | Yes |
t8mk |
128×128 8-bit mask | Yes |
icp4 |
16x16 32-bit PNG/JP2 icon | PNG only |
icp5 |
32x32 32-bit PNG/JP2 icon | PNG only |
icp6 |
64x64 32-bit PNG/JP2 icon | PNG only |
ic07 |
128x128 32-bit PNG/JP2 icon | PNG only |
ic08 |
256×256 32-bit PNG/JP2 icon | PNG only |
ic09 |
512×512 32-bit PNG/JP2 icon | PNG only |
ic10 |
512x512@2x "retina" 32-bit PNG/JP2 icon | PNG only |
ic11 |
16x16@2x "retina" 32-bit PNG/JP2 icon | PNG only |
ic12 |
32x32@2x "retina" 32-bit PNG/JP2 icon | PNG only |
ic13 |
128x128@2x "retina" 32-bit PNG/JP2 icon | PNG only |
ic14 |
256x256@2x "retina" 32-bit PNG/JP2 icon | PNG only |
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.