XOSD_CREATE(3)

💖 XOSD_CREATE 💖

okay bestie, welcome to the xosd_create(3) page — yes, that's the manual name, we're doing this 💅

---

✨ NAME ✨

xosd_create — make a brand new XOSD object, fresh out the box 🎀

---

🌸 SYNOPSIS 🌸

#include <xosd.h>

xosd *xosd_create (int number_lines);

---

🦋 DESCRIPTION 🦋

so xosd_init creates a new xosd window, and like… it's for showing off textual or numerical data on an X11 display. the vibe? an unmanaged, shaped window that appears to be transparent. it's giving on-screen display energy, like the little overlays on tons of televisions and video recorders. iconic honestly 💖

---

🎀 ARGUMENTS 🎀

• number_lines — the max number of lines of text the window can display. and bestie, listen: this value cannot be changed. it's locked in, no takebacks, periodt.

---

⭐ RETURN VALUE ⭐

if it ate, you get a pointer to a shiny new xosd object 🫶 if it didn't, you get NULL. that's it, that's the whole deal.

---

🌈 ENVIRONMENT 🌈

• DISPLAY — the environment variable that decides which X11 display the XOSD window shows up on. iykyk.
• char *xosd_error — a string to a text string describing the error. (yes, it says "a string to a text string", we're keeping it exactly like that, no cap 😭)

---

💜 HISTORY 💜

the xosd_create function first appeared in version 2.0 of the XOSD library, where it replaced the now deprecated xosd_init function. glow-up behavior fr fr ✨

---

👑 AUTHORS 👑

the XOSD library was originally written by André Renaud, and is currently maintained by Tim Wright. this document was written by Michael Jason-Smith. absolute legends, all of them 💅

---

💀 BUGS 💀

there are no known bugs with xosd_create. zero. none. flawless behavior 🙈

but if you do find something, bug reports can be sent to <xosd@ignavus.net>.

---

🔥 SEE ALSO 🔥

• xosd_destroy(3)
• xosd_show(3)
• xosd_set_pos(3)
• xosd_set_align(3)
• xosd_set_shadow_offset(3)
• xosd_set_offset(3)
• xosd_set_timeout(3)
• xosd_set_colour(3)
• xosd_set_font(3)
• xosd_show(3)
• xosd_scroll(3)

---

and that's the whole page, bestie 🧚 go forth and create your xosd objects. mwah 💖

XOSD_CREATE(3) — that's the footer, aka the source/version and date tag hanging out at the very bottom of the page, and yes we're shouting it out too because it deserves main character energy. bye bestie, slay 🎀✨