TICKIT_RENDERBUFFER_TEXTN(3)

💖 TICKIT_RENDERBUFFER_TEXT(3) 💖

okay bestie, so this is a page from the Library Functions Manual and it's all about tickit_renderbuffer_text, tickit_renderbuffer_text_at — aka the girls who create text regions ✨ (yes that's the whole NAME section, we're not skipping a crumb of it)

✨ SYNOPSIS ✨

#include <tickit.h>

int tickit_renderbuffer_text(TickitRenderBuffer *rb,
        const char *text);
int tickit_renderbuffer_textn(TickitRenderBuffer *rb,
        const char *text, size_t len);
int tickit_renderbuffer_textf(TickitRenderBuffer *rb,
        const char *fmt, ...);
int tickit_renderbuffer_vtextf(TickitRenderBuffer *rb,
        const char *fmt, va_list args);

int tickit_renderbuffer_text_at(TickitRenderBuffer *rb,
        int line, int col, const char *text);
int tickit_renderbuffer_textn_at(TickitRenderBuffer *rb,
        int line, int col, const char *text, size_t len);
int tickit_renderbuffer_textf_at(TickitRenderBuffer *rb,
        int line, int col, const char *fmt, ...);
int tickit_renderbuffer_vtextf_at(TickitRenderBuffer *rb,
        int line, int col, const char *fmt, va_list args);

Link with -ltickit.

ngl the Link with -ltickit. line is lowkey the most important line here, don't forget it or the linker will simply Not 💀

🦋 DESCRIPTION 🦋

tickit_renderbuffer_text() creates a text region that starts at the current virtual cursor position, holding the text string you handed it and set to the current pen. it's giving "just drop this text right here where I'm standing" 💅

tickit_renderbuffer_textn() creates a text region of at most len bytes. it returns the number of columns that the text string occupies. slay, measured and everything 📏✨

tickit_renderbuffer_textf() and tickit_renderbuffer_vtextf() take a format string in the style of sprintf(3) to create formatted text from either a list of arguments or a va_list. these functions will update the virtual cursor position.

tickit_renderbuffer_text_at(), tickit_renderbuffer_textn_at(), tickit_renderbuffer_textf_at() and tickit_renderbuffer_vtextf_at() create a text region at the given position, and otherwise operate analogously to their non-_at counterpart. these functions do not use or update the virtual cursor position. no cursor drama, they just show up exactly where you told them to 🎯

🧺 storage tea (the part nobody warns you about)

Calls to any of these functions allocate storage owned by the TickitRenderBuffer instance itself to store the strings. that storage gets released again by:

• tickit_renderbuffer_reset(3)
• the implicit reset that happens at the end of tickit_renderbuffer_flush_to_term(3)
• or when every cell that was originally part of the region has been overwritten with other content 👑

heads up fr fr: that memory belongs to the render buffer, not to you. don't go freeing it yourself, that's not the vibe 🙈

⭐ RETURN VALUE ⭐

These functions return an integer giving the number of columns the new region occupies. cute, concise, informative. periodt 💖

🌈 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, no crumbs left behind 🫶

signing off from the Library Functions Manual — this was TICKIT_RENDERBUFFER_TEXT(3), mwah 💋