Name

xosd_set_shadow_offset — Change the shadow-offset of the XOSD window

Synopsis

#include <xosd.h>
int xosd_set_shadow_offset(xosd * osd,
 int  shadow_offset);

Description

To increase readability (and 'cos it looks cool) a black shadow can be drawn beneath the text and graphics displayed by XOSD. xosd_set_shadow_offset changes the size of this shadow by altering how many pixels the shadow is offset (to the bottom-right) from the main display. One to four pixels usually is sufficient to get a good effect.

Arguments

osd

The XOSD window to change.

shadow_offset

The number of pixels the shadow is offset from the main display. Initially the shadow-offset is zero.

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.

See Also

xosd_create(3xosd), xosd_set_shadow_colour(3xosd), xosd_outline_offset(3xosd).