TICKIT_RENDERBUFFER_ERASE(3)

💖 TICKIT_RENDERBUFFER_ERASE 💖

okay bestie, so this is a page from the Library Functions Manual for the Tickit renderbuffer erase squad: tickit_renderbuffer_erase, tickit_renderbuffer_erase_to, and tickit_renderbuffer_erase_at. Three functions, one job: create erase regions. no cap. let's get into it 🫶

✨ NAME ✨

tickit_renderbuffer_erase, tickit_renderbuffer_erase_to, tickit_renderbuffer_erase_at — create erase regions 🧚

🌸 SYNOPSIS 🌸

#include <tickit.h>

void tickit_renderbuffer_erase(TickitRenderBuffer *rb,
         int cols);
void tickit_renderbuffer_erase_to(TickitRenderBuffer *rb,
         int col);
void tickit_renderbuffer_erase_at(TickitRenderBuffer *rb,
         int line, int col, int cols);

Link with -ltickit.

💅 DESCRIPTION 💅

so tickit_renderbuffer_erase() is giving main character energy: it creates an erase region that starts right at the current virtual cursor position and keeps going for cols cells, all set to the current pen. periodt. ✨

tickit_renderbuffer_erase_to() is the flexible one — it creates an erase region that continues until the given column col, if the cursor was before that. but if the cursor was already after that column? yeah, it literally does nothing. no effect, we move on. 🙈

and here's the thing — both of those functions will update the virtual cursor position. so like, they move the cursor, iykyk. 👑

then there's tickit_renderbuffer_erase_at(), which is lowkey the independent one. it creates an erase region at the given position (line, col) and length (cols). this function does not use or update the virtual cursor position. it's off doing its own thing, unbothered, moisturized, in its own lane. 💜

🎀 RETURN VALUE 🎀

these functions return nothing. that's it, that's the whole section. void behavior, void vibes. 💀

🔥 SEE ALSO 🔥

• tickit_renderbuffer_new(3)
• tickit_renderbuffer_blit(3)
• tickit_renderbuffer_flush_to_term(3)
• tickit_renderbuffer(7)
• tickit(7)

and that's the whole page, bestie 🦋 mwah. this was TICKIT_REN...UFFER_ERASE(3) from the Library Functions Manual — literally iconic, go erase some regions responsibly 💖✨🌈