Struct IcoBuilder

Source

pub struct IcoBuilder { /* private fields */ }

Expand description

Builds an ICO file from individual files. For each size, the closest source image is scaled down to the appropriate size.

Implementations§

Source §

impl IcoBuilder

Source

pub fn sizes(&mut self, sizes: impl Into<IconSizes>) -> &mut IcoBuilder

Customizes the sizes included in the ICO file. Defaults to IconSizes::MINIMAL.

Source

pub fn add_source_file( &mut self, source_file: impl AsRef<Path>, ) -> &mut IcoBuilder

Adds a source file. These file can be PNG, BMP or any other format supported by the image crate. The icons are assumed to be a square.

Note that you’ll have to enable the necessary features on the image crate if you want to use formats other than PNG or BMP:

# ...

[dependencies]
ico-builder = { version = "...", features = ["jpeg"] }

Examples found in repository ?

examples/default-sizes.rs (line 6)

4fn main() -> Result<(), Box<dyn Error>> {
5    IcoBuilder::default()
6        .add_source_file("examples/icons/icon-32x32.png")
7        .add_source_file("examples/icons/icon-256x256.png")
8        .build_file("examples/icons/icon.ico")?;
9    Ok(())
10}

Source

pub fn add_source_files( &mut self, source_files: impl IntoIterator<Item = impl AsRef<Path>>, ) -> &mut IcoBuilder

Adds sources files. See: IcoBuilder::add_source_file.

Source

pub fn filter_type(&mut self, filter_type: FilterType) -> &mut IcoBuilder

Customizes the filter type used when downscaling the images. Defaults to FilterType::Lanczos3.

Source

pub fn build_file(&self, output_file_path: impl AsRef<Path>) -> Result<()>

Builds the ICO file and writes it to the specified output_file_path.

Examples found in repository ?

examples/default-sizes.rs (line 8)

4fn main() -> Result<(), Box<dyn Error>> {
5    IcoBuilder::default()
6        .add_source_file("examples/icons/icon-32x32.png")
7        .add_source_file("examples/icons/icon-256x256.png")
8        .build_file("examples/icons/icon.ico")?;
9    Ok(())
10}