xosd_get_colour

Prev		Next

Name

xosd_get_colour — Get the colour of the data displayed the XOSD window

Synopsis

#include <xosd.h>

`int xosd_get_colour(`	xosd *	osd,
	int *	red,
	int *	green,
	int *	blue`)`;

Description

xosd_get_colour returns the current colour being used to display text and graphics in an XOSD window. The value is passed back as three interger values, one for the red-component of the colour, one for the green-component, and one blue-component.

Arguments

osd: The XOSD window to query.
red: A pointer to an interger which will be set to the red-component of the colour. If red is NULL it will not be set.
green: A pointer to an interger which will be set to the green-component of the colour. If green is NULL it will not be set.
blue: A pointer to an interger which will be set to the blue-component of the colour. If blue is NULL it will not be set.

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.

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_get_colour. Bug reports can be sent to <xosd@ignavus.net>.