Name

xosd_set_pos — Change the vertical position of the XOSD window

Synopsis

#include <xosd.h>

int xosd_set_pos(xosd *osd, xosd_pos pos);

Description

xosd_set_pos changes the vertical position of the XOSD window. There are three possible vertical positions for the XOSD window, corresponding to the top, middle or bottom of the display. By default the XOSD window is positioned at the top of the display.

Arguments

osd

The XOSD window to change.

pos

The position of the display. The value of pos can be one of the following three values.

  • XOSD_top for the top (the default),

  • XOSD_middle for the middle, or

  • XOSD_bottom for the bottom 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_pos

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

  • XOSD_top,

  • XOSD_bottom, and

  • XOSD_middle.

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

The xosd_pos enumeration defines the three constants in an illogical order, with XOSD_middle at the end. Bug reports can be sent to .

See Also

xosd_create(3xosd), xosd_set_align(3xosd)