Name

xosd_hide — Make the XOSD window invisible

Synopsis

#include <xosd.h>

int xosd_hide(xosd *osd);

Description

xosd_hide is called to unmap (hide) an XOSD window that is currently displaying data. Normally the XOSD window will be visible until the timeout limit, set by calling xosd_set_timeout(3xosd), is reached; xosd_hide is used to prematurely remove the XOSD window from the display. To redisplay the XOSD window call xosd_show(3xosd).

Arguments

osd

The XOSD window to hide.

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), xosd_set_timeout(3xosd), xosd_show(3xosd).