xosd_create(3)

1XOSD_CREATE(3xosd)                                          XOSD_CREATE(3xosd)
2
3
4

NAME

6       xosd_create - Create a new XOSD object
7

SYNOPSIS

9       #include <xosd.h>
10
11
12       xosd *xosd_create (int number_lines);
13
14

DESCRIPTION

16       xosd_init creates a new xosd window that can be used to display textual
17       or numerical data on a X11 display in a unmanaged, shaped  window  that
18       appears  to  be  transparent.  It  provides a similar effect to the on-
19       screen display of many televisions and video recorders.
20
21

ARGUMENTS

23       number_lines
24              The maximum number of lines of text that the window can display.
25              This value cannot be changed.
26
27

RETURN VALUE

29       On  success  a pointer to a new xosd object is returned, otherwise NULL
30       is returned.
31
32

ENVIRONMENT

34       DISPLAY
35              The environment variable that determines which X11  display  the
36              XOSD window appears.
37
38
39       char *xosd_error
40              A string to a text string describing the error.
41
42

HISTORY

44       The  xosd_create function first appeared in version 2.0 of the XOSD li‐
45       brary, replacing the now depricated xosd_init function.
46
47

AUTHORS

49       The XOSD library was originally written by André Renaud, and is curren‐
50       ly  maintained  by Tim Wright. This document was written by Michael Ja‐
51       sonSmith.
52
53

BUGS

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

60        xosd_destroy(3xosd),       xosd_show(3xosd),      xosd_set_pos(3xosd),
61       xosd_set_align(3xosd),   xosd_set_shadow_offset(3xosd),   xosd_set_off‐
62       set(3xosd),       xosd_set_timeout(3xosd),      xosd_set_colour(3xosd),
63       xosd_set_font(3xosd), xosd_show(3xosd), xosd_scroll(3xosd),
64
65
66
67
68                                                            XOSD_CREATE(3xosd)