xosd_is_onscreen(3)

1XOSD_IS_ONSCREEN(3xosd)                                XOSD_IS_ONSCREEN(3xosd)
2
3
4

NAME

6       xosd_is_onscreen - Returns wether the XOSD window is shown
7

SYNOPSIS

9       #include <xosd.h>
10
11
12       xosd *xosd_is_onscreen (xosd *osd);
13
14

DESCRIPTION

16       osd_is_onscreen  determines  weather  a XOSD window, is currently being
17       shown (is mapped to the X display). Because XOSD  displays  data  asyn‐
18       chronously (see xosd_display(3xosd) for details) it can be difficult to
19       know if data is being displayed, xosd_is_onscreen solves this problem.
20
21
22       Call xosd_show(3xosd) or xosd_hide(3xosd) to alter  the  visibility  of
23       the XOSD window.
24
25

ARGUMENTS

27       osd    The XOSD window to query.
28
29

RETURN VALUE

31       A  1 is returned if the window is onscreen (mapped), or 0 if it is hid‐
32       den (unmapped). On error, -1 is returned and xosd_error is set to indi‐
33       cate the reason for the error.
34
35

ENVIRONMENT

37       char *xosd_error
38              A string to a text string describing the error, if one occurred.
39
40

HISTORY

42       The xosd_is_onscreen function first appeared in version 2.1 of the XOSD
43       library.
44
45

AUTHORS

47       The XOSD library was originally written by André Renaud and is currenly
48       maintained by Tim Wright, who also wrote the xosd_is_onscreen function.
49       Michael JasonSmith thinks he wrote this document, but is not sure; drop
50       Micahel  an  email (<mike@ldots.org>) if you think he didn't write this
51       document.
52
53

BUGS

55       There are no known bugs with xosd_is_onscreen. Bug reports can be  sent
56       to <xosd@ignavus.net>.
57
58