Prev   Next

Name

xosd_set_colour — Change the colour of the data displayed the XOSD window

Synopsis

#include <xosd.h>
int xosd_set_colour(xosd * osd,
 const char * colour);

Description

xosd_set_colour changes the colour of all the text and graphics displayed in the XOSD window. By default the colour is "green". xosd_set_colour will change the colour of the text and graphics to white if it could not change to the specified colour.

Arguments

osd

The XOSD window to query.

colour

The colour of the text and graphics displayed in the XOSD window. The colour can be specified by name, such as "green", or by a hexadecimal colour specifier, such as "#5eff72". (For a complete list of valid colour names see the file rgb.txt in you X11 distribution.)

Return Value

On success a zero is returned. On error -1 is returned and xosd_error is set to indicate the reason for the error.

Environment

char *xosd_error

A string describing the error, if one occurred.

rgb.txt

A list of all valid colour names. It is normally distributed as part of X11.

Authors

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

Bugs

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

See Also

xosd_create(3xosd), xosd_get_colour(3xosd), xosd_set_outline_colour(3xosd).

Prev Up Next
 Home