lzss_write(3alleg4)

💖 lzss_write — bestie, let's squeeze some bytes 💖

okay so you're reading the Allegro manual page for lzss_write (that's the 3alleg4 section, for all my fellow Allegro game-dev girlies 👑). This is the Allegro game programming library, and this function is the one that does the actual LZSS squeezing. Compression era, no cap. 🎀

✨ SYNOPSIS ✨

#include <allegro.h>

int lzss_write(PACKFILE *file, LZSS_PACK_DATA *dat, int size, unsigned
char *buf, int last);

look at her. four args, one job. 💅

🌸 DESCRIPTION 🌸

So here's the tea, bestie: lzss_write packs size bytes straight out of buf, and it uses the pack info that's already chillin' inside dat to do it. The compressed bytes then get stored into file. that's it. that's the whole vibe. 🦋

like, think of dat as the little brain 🧠 that remembers everything about the compression run so far, buf as the raw data you're handing over, and file as the PACKFILE that's about to receive the glow-up. ✨

💫 RETURN VALUE 💫

• Returns 0 on success 🫶 (we love a zero, it's giving "we ate")
• Returns EOF if there was an error 😭 (not iconic. we don't claim that energy.)

fr fr, always check that return value. EOF is your sign that something went sideways and the data did not get packed the way you wanted. 🙈

🧚 SEE ALSO 🧚

• create_lzss_pack_data(3alleg4) — go make yourself some pack data first, you can't do the thing without it 💜
• free_lzss_pack_data(3alleg4) — and clean up after yourself when you're done, we're not messy here 🎀

and that's the page!! this one came from the Allegro manual, version 4.4.3, and yeah — lzss_write(3alleg4) forever. mwah 💋 periodt. 💖