Name

xosd_set_outline_colour — Change the outline colour of the data displayed the XOSD window

Synopsis

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

Description

xosd_set_outline_colour changes the colour of the border that surrounds all text and graphics displayed in the XOSD window. By default the outline is black, but it is invisible until xosd_set_outline_offset(3xosd) is called.

Arguments

osd

The XOSD window to alter.

colour

The colour of the outline. 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.

History

The xosd_set_outline_colour function first appeared in version 2.2 of the XOSD library.

Authors

The XOSD library was originally written by André Renaud, and is currently maintained by Tim Wright. Outline support was created by Andy Heroff, and xosd_set_outline_colour was written by Tim Wright. This document was written by Michael JasonSmith.

Bugs

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

See Also

xosd_create(3xosd), xosd_set_outline_offset(3xosd), xosd_set_colour(3xosd).