ktx_deflate(1)

💅 ktx_deflate — the KTX Tools Reference, bestie edition ✨

okay so real talk, this is the manual for ktx_deflate, and it lives in the KTX Tools Reference family. Let me tell you everything about it, no cap 🫶

✨ NAME ✨

ktx_deflate — lowkey its whole personality is: deflate stuff.

Like, it deflates (a.k.a. supercompresses) a KTX2 file. That's the vibe. 🎀

🌸 SYNOPSIS 🌸

ktx deflate [option...] input-file output-file

🦋 DESCRIPTION 🦋

So here's the tea ☕: ktx deflate takes the KTX file you name as input-file and deflates it (supercompresses it, bestie, we're squeezing it down) and saves the result as output-file.

A few little details you literally cannot skip:

• if input-file is -, the file gets read from stdin 👀
• if output-path is -, the output gets written to stdout 💫
• if your input file is already supercompressed, it gets inflated first and then supercompressed again using the options you passed here — and you'll get a warning about it. not me being nosy, that's just what happens 🙈
• if the input file is invalid, the first validation error it runs into gets printed to stderr and the command exits with the relevant non-zero status code. so yeah, it will absolutely tell on you 💀

⚠️ ngl this is important: ktx deflate cannot be applied to KTX files that have been supercompressed with BasisLZ. that's just not a thing it does. periodt.

---

🎀 OPTIONS 🎀

here's the whole menu, the following options are available:

• --zstd <level> — supercompress the data with Zstandard. cannot be used with ETC1S / BasisLZ format. level range is [1,22]. lower levels give you faster but worse compression. and values above 20? use those with caution because they require more memory 🧠🔥
• --zlib <level> — supercompress the data with ZLIB. cannot be used with ETC1S / BasisLZ format. level range is [1,9]. lower levels give faster but worse compression, same deal as above 💅
• -q, --quiet — silences the warning about an already supercompressed input file. shhh 🤫
• -e, --warnings-as-errors — treats warnings as errors. strict queen behavior 👑
• -h, --help — prints this usage message and exits. the classic escape hatch 🚪
• -v, --version — prints the version number of this program and exits. gotta know what you're working with ✨

---

⭐ EXIT STATUS ⭐

like, the number it leaves behind says everything about how it went:

1. 0 — success 🎉 slay
2. 1 — command line error 🫠
3. 2 — IO failure 😭
4. 3 — invalid input file 💀
5. 4 — runtime or library error 🙈
6. 5 — not supported state or operation 🚫
7. 6 — requested feature is not yet implemented (soon tho, hopefully) 🧚

---

🌈 HISTORY 🌈

Version 4.0

• initial version — everyone starts somewhere 🎀

---

💜 AUTHOR 💜

• Mark Callow [@MarkCallow] — the icon, the legend, the main character 👑🫶

---

and that's the whole page bestie!! 🌸 this absolute gem comes to you from Version 0.0.0, dated Tue Jan 1 1980 00:00:00 — yes, the most iconic timestamp of all time 💖 go forth and deflate responsibly, ily, bye 👋✨