Prev   Next

Name

xosd_set_align — Change the horizontal position of the XOSD window

Synopsis

#include <xosd.h>
int xosd_set_align(xosd * osd,
 xosd_align  align);

Description

xosd_set_align changes the horizontal alignment of the XOSD window. There are three possible horizontal positions for the XOSD window, corresponding to the top, middle, or bottom of the display. By default the XOSD window is aligned at the left of the display.

Arguments

osd

The XOSD window to change.

align

The alignment of the display. There are three possible values for align

  • XOSD_left for the left (the default),

  • XOSD_center for the center, and

  • XOSD_right for the right of the display.

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.

enum xosd_align

The possible horizontal alignment of the display, defined as an enumerated type. There are three values defined:

  • XOSD_left,

  • XOSD_center, and

  • XOSD_right.

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_align. Bug reports can be sent to .

See Also

xosd_create(3xosd), xosd_set_pos(3xosd)

Prev Up Next
 Home