---
name: "img-ico"
section: "3tk"
platform: "linux"
package: "libtk-img-doc"
version: "1:2.0.1+dfsg1-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/img-ico"
---

# img-ico(3tk)

Windows icon format (ico)

```

```

## NAME

img-ico - Windows icon format (ico)

## SYNOPSIS

package require **img::ico ?2.0?**

```

```

## DESCRIPTION

**package require img::ico**

Like all packages of **Img** it does *not* provide new commands, but extends the existing **Tk** command **image**, so that it supports files containing raster images in the Windows icon format (ico). More specifically **img::ico** extends **Tk**'s *photo* \[https://www.tcl.tk/man/tcl9.0/TkCmd/photo.html\] image type.

The name of the new format handler is **ico**. This handler provides new additional configuration options. See section **Options** for more detailed explanations.

All of the above means that in a call like **image** **create photo** ?*name*? ?*options*?

- \[1\]

  Image data in ico format (options **-data** and **-file**) is detected automatically.

- \[2\]

  The format name **ico** is recognized by the option **-format**.

In addition the value of option **-format** is treated as a list and may contain any of the special options listed in section **Options**.

The package **img::ico** is a sub-package of **Img**. It can be loaded as a part of the complete Img support, via **package require Img**, or on its own, via **package require img::ico**.

## SUPPORTED TYPES

This format handler supports the following image types:

- •

  1-bit pixels: Black and White.

- •

  4-bit pixels: Grayscale or indexed.

- •

  8-bit pixels: Grayscale or indexed.

- •

  24-bit pixels: Truecolor (GBR,  8-bit channels).

- •

  32-bit pixels: Truecolor (GBRA, 8-bit channels).

```
 Image  |     Read      |     Write     |
 type   | -file | -data | -file | -data |
 ----------------------------------------
  1-bit | Yes   | Yes   | No    | No    |
  4-bit | Yes   | Yes   | No    | No    |
  8-bit | Yes   | Yes   | Yes   | Yes   |
 24-bit | Yes   | Yes   | Yes   | Yes   |
 32-bit | Yes   | Yes   | No    | No    |
```

## NOTES

- \[1\]

  Chapter *Multi-page Images* of the **Img** manual page describes the handling of images with multiple pages.

## OPTIONS

The handler provides the following options:

- **-verbose** *bool*

  This option is supported for reading and writing. Available since version 1.3.

  If set to **true**, additional information about the read or written image is printed to stdout. Default is **false**.

- **-index** *integer*

  This option is supported for reading only. Available since version 1.3.

  Read the page at specified index. The first page is at index **0**. Default is **0**.

## SEE ALSO

img, img-bmp, img-dted, img-flir, img-gif, img-ico, img-jpeg, img-pcx, img-pixmap, img-png, img-ppm, img-ps, img-raw, img-sgi, img-sun, img-tga, img-tiff, img-window, img-xbm, img-xpm

## COPYRIGHT

```
Copyright (c) 1995-2024 Jan Nijtmans <nijtmans@users.sourceforge.net>
Copyright (c) 2002-2024 Andreas Kupries <andreas_kupries@users.sourceforge.net>
Copyright (c) 2003-2024 Paul Obermeier <obermeier@users.sourceforge.net>
```