xosd_set_outline

Prev		Next

Name

xosd_set_outline_offset — Change the size of the outline of the data displayed in the XOSD window

Synopsis

#include <xosd.h>

`int xosd_set_outline_offset(`	xosd *	osd,
	int	offset`)`;

Description

xosd_set_outline_offset changes the width (in pixels) of the outline which can be drawn on all text and graphics displayed in the XOSD window. This helps increase legibility, much like xosd_set_shadow_offset(3xosd). By default there is no outline (it is zero pixels wide); anything larger than two pixels looks odd.

Arguments

osd: The XOSD window to alter.
offset: The width of the outline in pixels

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.

History

The xosd_set_outline_offset 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_offset was written by Tim Wright. This document was written by Michael JasonSmith.

Bugs

There are no known bugs with xosd_set_outline_offset. Bug reports can be sent to <xosd@ignavus.net>.