Function Reference

The XOSD library provides an object-oriented C API. The style of the functions is similar to those found in the GTK+ libraries, with constructor and destructor functions, functions to get and set attributes, and function to controll the display of data.

Table of Contents

I. Creating and Destroying
xosd_create - Create a new XOSD window
xosd_destroy - Destroy an XOSD window
II. Getting and Setting Attributes
xosd_set_pos - Change the vertical position of the XOSD window
xosd_set_align - Change the horizontal position of the XOSD window
xosd_set_vertical_offset - Change the vertical offset of the XOSD window
xosd_set_horizontal_offset - Change the horizontal offset of the XOSD window
xosd_set_colour - Change the colour of the data displayed the XOSD window
xosd_get_colour - Get the colour of the data displayed the XOSD window
xosd_set_shadow_offset - Change the shadow-offset of the XOSD window
xosd_set_outline_offset - Change the size of the outline of the data displayed in the XOSD window
xosd_set_outline_colour - Change the outline colour of the data displayed the XOSD window
xosd_set_font - Change the font used by the XOSD window
xosd_set_timeout - Change the time before the XOSD window is hidden
xosd_get_number_lines - Get the number of lines able to be shown by the XOSD window
xosd_set_bar_length - Change the length of the percentage bar or slider
III. Displaying Data
xosd_display - Display data to an XOSD window
xosd_show - Make the XOSD window visible
xosd_hide - Make the XOSD window invisible
xosd_scroll - Scroll the XOSD window
xosd_is_onscreen - Returns wether the XOSD window is shown
xosd_wait_until_no_display - Suspend execution until the XOSD window is hidden
IV. Command-Line Utilities
osd_cat - X on-screen file displayer
xosd-config - Get information about the installed version of libxosd