Name

xosd_scroll — Scroll the XOSD window

Synopsis

#include <xosd.h>

int xosd_scroll(xosd *osd, int lines);

Description

xosd_scroll is called to scroll the XOSD window up so the bottom lines are blank. The number of lines that can be scrolled cannot be greater than the total number of lines in a XOSD window, which is set when the window is created by xosd_create(3xosd), and cannot be changed.

Arguments

osd

The XOSD window to scroll.

lines

The number of lines to scroll.

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_display(3xosd).