Prev   Next

Name

xosd_create — Create a new XOSD window

Synopsis

#include <xosd.h>

xosd *xosd_create(int number_lines);

Description

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

By default the XOSD window is placed at the top-left of the display, with the horizontal and vertical offsets set to zero. Text is displayed in green, using the fixed font by default. These values can be changed by using one of the setter methods listed in the See Also section below.

Arguments

number_lines

The maximum number of lines of text that the window can display. This value cannot be changed.

Return Value

On success a pointer to a new xosd window is returned, otherwise NULL is returned.

Environment

DISPLAY

The environment variable that determines which X11 display the XOSD window appears.

char *xosd_error

A string describing the error, if one occurred.

History

The xosd_create function first appeared in version 2.0 of the XOSD library, replacing the now depricated xosd_init function.

Authors

The XOSD library was originally written by André Renaud, and is currenly maintained by Tim Wright. This document was written by Michael JasonSmith.

Bugs

There are no known bugs with xosd_create. Bug reports can be sent to .

See Also

xosd_destroy(3xosd), xosd_display(3xosd), xosd_show(3xosd), xosd_hide(3xosd), xosd_set_pos(3xosd), xosd_set_align(3xosd), xosd_set_shadow_offset(3xosd), xosd_set_vertical_offset(3xosd), xosd_set_horizontal_offset(3xosd), xosd_set_timeout(3xosd), xosd_set_colour(3xosd), xosd_get_colour(3xosd), xosd_set_font(3xosd), xosd_scroll(3xosd),

Prev Up Next
 Home