xosd_hide(3)

πŸ“¦
version 2.2.15 Β· 2 versions
, in arch rolling, debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ xosd_hide β€” bestie edition ✨

okay so this is the xosd_hide page from the XOSD Library manual, section 3 (library functions, iykyk). it's short, it's sweet, it's giving "one job, done perfectly." let's get into it πŸ’…


🌸 NAME 🌸

xosd_hide β€” hide the XOSD window. that's it. that's the whole job. hide it. bye πŸ‘‹


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <xosd.h>

int xosd_hide (xosd* osd);

so you #include <xosd.h> at the top, then you call xosd_hide with your xosd* and it hands you back an int. simple. clean. iconic. ✨


πŸ’– DESCRIPTION πŸ’–

okay bestie, listen up: xosd_hide hides (which here means unmaps) the xosd window. it's not gone-gone, it's just not on screen anymore. like when you mute the group chat but you're still in it. 🫢

and the moment you want it back? you call xosd_show(3) and boom, the window is visible again. one call out, one call back in. main character energy. πŸ‘‘

now here's the tea on why you'd even do this. when you call xosd_display(3), the data stays on screen until the pre-set time has elapsed. that's the default behaviour, it just sits there vibing until the timer runs out. but if you're impatient (no judgement, same) you can call xosd_hide and the window gets prematurely removed from the display. timer said no, you said yes. πŸ’…


πŸŽ€ ARGUMENTS πŸŽ€

  • osd β€” the on-screen display object to act on. this is your little guy. your osd. point xosd_hide at it and it knows exactly who to hide. πŸ“

⭐ RETURN VALUE ⭐

  • on success, a 0 is returned. slay, we love a zero. πŸ’š
  • on error, -1 is returned. 😭 not slay. go check what happened.

🌈 SEE ALSO 🌈

the whole friend group, fr fr:


heads up bestie: the window you're hiding only comes back if you explicitly call xosd_show(3). xosd_hide doesn't un-hide itself. she's not a boomerang. πŸ™ˆ

that's the page!! sourced straight from the X OSD Library, dated 2002-06-25 β€” a vintage classic that still ate, honestly. periodt. πŸ’œπŸ§šπŸŒΈ