img-sun(n)

💖 NAME 💖

img-sun — the Sun raster format handler (aka sun), living its best life inside Img.

---

✨ SYNOPSIS ✨

package require img::sun ?2.1?

---

🦋 DESCRIPTION 🦋

okay so first things first: package require img::sun 👑

Like literally every other package in Img, this one is not out here inventing new commands. Nope. What it does is extend the existing Tk command image, so that command suddenly understands files holding raster images in the Sun raster format (sun). More specifically, img::sun extends Tk's photo image type — you know, the one documented over at https://www.tcl.tk/man/tcl9.0/TkCmd/photo.html.

The name of the new format handler is sun. This handler brings some new extra configuration options to the table. Peep the OPTIONS section for the full tea. ☕

All of that means that in a call like

image create photo ?name? ?options?

here's what goes down:

1. Image data in sun format (that's the -data and -file options) gets detected automatically. no cap, it just knows. 🔍
2. The format name sun is recognized by the -format option. 🎯

On top of that, the value of the -format option is treated as a list and may contain any of the special options listed in the OPTIONS section. so you can stack them in there, bestie.

And jsyk: the package img::sun is a sub-package of Img. You can load it as part of the whole complete Img support situation, via package require Img, or you can pull it up all on its own, via package require img::sun. main character energy either way 💅

---

🌈 SUPPORTED TYPES 🌈

This format handler supports the following image types:

• 1-bit pixels: Black and White. 🖤🤍
• 8-bit pixels: Grayscale or indexed. 🌫️
• 24-bit pixels: Truecolor (RGB, 8-bit channels). 🌺
• 32-bit pixels: Truecolor with alpha channel (RGBA, 8-bit channels). ✨

All images types may be either uncompressed or run-length encoded.

Here's the whole read/write situation, broken down for you because tables are so not the vibe:

• 1-bit — read -file: Yes | read -data: Yes | write -file: No | write -data: No
• 8-bit — read -file: Yes | read -data: Yes | write -file: No | write -data: No
• 24-bit — read -file: Yes | read -data: Yes | write -file: Yes | write -data: Yes
• 32-bit — read -file: Yes | read -data: Yes | write -file: Yes | write -data: Yes

---

🎀 OPTIONS 🎀

The handler provides the following options:

• -verbose bool — supported for reading and writing. Available since version 1.3. If you set it to true, extra information about the read or written image gets printed to stdout. Default is false. (so like, quiet by default, chatty if you ask 🗣️)
• -withalpha bool — supported for reading and writing. Available since version 1.3. If set to false, an alpha channel is ignored during reading or writing. Default is true.

Note: this option was named -matte in previous versions and is still recognized. old name, same energy 🫶

• -compression string — supported for writing only. Available since version 1.3. Set the compression mode to either none or rle. Default is rle. 🗜️

---

👀 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

(the whole friend group fr fr 💞)

---

📜 COPYRIGHT 📜

Copyright (c) 1995-2025 Jan Nijtmans <nijtmans@users.sourceforge.net>

Copyright (c) 2002-2025 Andreas Kupries <andreas_kupries@users.sourceforge.net>

Copyright (c) 2003-2025 Paul Obermeier <obermeier@users.sourceforge.net>

---

okay that's the whole page bestie, you're officially caught up 🧚✨ this was img-sun, version 2.1 — thanks for coming to my ted talk, ily, go make some iconic sun raster images 💖🌟