XOSD_IS_ONSCREEN(3)

💖 XOSD_IS_ONSCREEN(3) — the manual page, bestie edition 💖

okay so this is xosd_is_onscreen(3), section 3 of the manual (the library functions girlies 🫶). sit down, grab a strawberry drink 🍓, and let's talk about how you find out if your OSD is actually, like, on the screen.

---

✨ NAME ✨

xosd_is_onscreen — tells you whether the XOSD window is currently being shown 👀

---

🌸 SYNOPSIS 🌸

#include <xosd.h>

xosd *xosd_is_onscreen (xosd *osd);

---

🦋 DESCRIPTION 🦋

xosd_is_onscreen determines whether an XOSD window is currently being shown — meaning, is it mapped to the X display? 💅

here's the tea: XOSD displays data asynchronously (go read xosd_display(3) for the details, iykyk), so it can be genuinely hard to know whether your data is being displayed or not. that's the whole problem. xosd_is_onscreen solves it. periodt. 👑

and if you want to change the visibility of the XOSD window? call xosd_show(3) or xosd_hide(3). those are your girls. ✨

---

🎀 ARGUMENTS 🎀

• osd — the XOSD window you wanna query. that's it, that's the whole argument. 💜

---

🌈 RETURN VALUE 🌈

• 1 — the window is onscreen (mapped) 💖
• 0 — the window is hidden (unmapped) 🙈
• -1 — something went wrong 😭 and xosd_error gets set to tell you why.

---

🧚 ENVIRONMENT 🧚

• char *xosd_error — a string, pointing at a text string that describes the error, if one occurred. your little error diary. 📓

---

⭐ HISTORY ⭐

the xosd_is_onscreen function first appeared in version 2.1 of the XOSD library. so it's been iconic for a minute. 🔥

---

👑 AUTHORS 👑

the XOSD library was originally written by André Renaud, and is currently maintained by Tim Wright, who also wrote the xosd_is_onscreen function. Michael JasonSmith thinks he wrote this document, but is not sure. drop Micahel an email (<mike@ldots.org>) if you think he didn't write this document. 💀 (not me spelling it "Micahel", that's literally what the manpage says, no cap)

---

💀 BUGS 💀

there are no known bugs with xosd_is_onscreen. she's clean, she's flawless, she ate. 🍽️

bug reports can be sent to <xosd@ignavus.net> if you somehow find one. 🫶

---

🔥 SEE ALSO 🔥

xosd_display(3), xosd_show(3), xosd_hide(3).

---

mwah 💋 that's the whole page, bestie — go forth and vibe check your windows. this was xosd_is_onscreen(3) from the XOSD library, and you've officially reached the end of the page. main character energy, honestly. 🌟