1XOSD(3xosd)                                                        XOSD(3xosd)
2
3
4

NAME

6       xosd - X on-screen display library
7

SYNOPSIS

9       #include <xosd.h>
10
11       xosd* xosd_create(int number_lines);
12
13       int xosd_uninit (xosd* osd);
14
15       int xosd_display (xosd* osd, int line,
16                         xosd_command command, ...);
17
18       int xosd_is_onscreen(xosd* osd);
19
20       int xosd_wait_until_no_display(xosd* osd);
21
22       int xosd_hide (xosd* osd);
23
24       int xosd_show (xosd* osd);
25
26       int xosd_set_pos (xosd* osd, xosd_pos pos);
27
28       int xosd_set_vertical_offset (xosd* osd, int offset);
29
30       int xosd_set_horizontal_offset (xosd* osd, int offset);
31
32       int xosd_set_align (xosd* osd, xosd_align align)
33
34       int xosd_set_shadow_offset (xosd* osd, int shadow_offset);
35
36       int xosd_set_timeout (xosd* osd, int timeout);
37
38       int xosd_set_font (xosd* osd, char* font);
39
40       int xosd_set_colour (xosd* osd, char* colour);
41
42       int xosd_get_colour (xosd* osd,
43                            int* red, int* green, int* blue);
44
45       int xosd_scroll (xosd* osd, int lines);
46
47       int xosd_get_number_lines ( xosd* osd);
48
49

DESCRIPTION

51       xosd  is a library for displaying an on-screen display (like the one on
52       many TVs) on your X display. Each function should have  it's  own  man‐
53       page.
54
55       The latest version can be found on http://www.ignavus.net/software.html
56
57       It is distributed under the GNU General Public License.
58
59

BUGS

61       No  known  bugs at the moment. There are probably functions that aren't
62       listed here.
63
64       Bug reports can be sent to tnw13@cosc.canterbury.ac.nz
65
66

EXAMPLE

68       #include <xosd.h>
69
70       int main (int argc, char *argv[])
71       {
72            xosd *osd;
73
74            osd = xosd_create (1);
75
76            xosd_set_font(osd, "fixed");
77            xosd_set_colour(osd, "LawnGreen");
78            xosd_set_timeout(osd, 3);
79            xosd_set_shadow_offset(osd, 1);
80
81            xosd_display (osd, 0, XOSD_string, "Example XOSD output");
82
83            xosd_wait_until_no_display(osd);
84
85            xosd_uninit (osd);
86
87            return EXIT_SUCCESS;
88       }
89
90

AUTHOR

92       Martijn van de Streek <martijn@foodfight.org>, Some patching by Malcolm
93       Valentine <farkit@iprimus.com.au> and Tim Wright <tim@ignavus.net>.
94
95       xosd  was written by Andre Renaud <andre@ignavus.net> and is maintained
96       by Tim Wright <tim@ignavus.net>.
97

SEE ALSO

99       More information on the X OSD Library and its author can  be  found  on
100       http://www.ignavus.net/software.html.  Each  function  has its own man-
101       page.  See there for more information.
102
103
104
105X OSD Library                    December 2000                     XOSD(3xosd)
Impressum