logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

xosd_is_onscreen - Returns wether the XOSD window is shown

Arguments

osd    The XOSD window to query.

Authors

       The XOSD library was originally written by AndrΓ© Renaud and is currenly maintained by Tim Wright, who al‐
       so wrote the xosd_is_onscreen function. Michael JasonSmith thinks he wrote  this  document,  but  is  not
       sure; drop Micahel an email (<mike@ldots.org>) if you think he didn't write this document.

Bugs

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

Description

osd_is_onscreen  determines weather a XOSD window, is currently being shown (is mapped to the X display).
       Because XOSD displays data asynchronously (see xosd_display(3) for details) it can be difficult  to  know
       if data is being displayed, xosd_is_onscreen solves this problem.

       Call xosd_show(3) or xosd_hide(3) to alter the visibility of the XOSD window.

Environment

char*xosd_error
              A string to a text string describing the error, if one occurred.

History

       The xosd_is_onscreen function first appeared in version 2.1 of the XOSD library.

Name

       xosd_is_onscreen - Returns wether the XOSD window is shown

Return Value

       A  1 is returned if the window is onscreen (mapped), or 0 if it is hidden (unmapped). On error, -1 is re‐
       turned and xosd_error is set to indicate the reason for the error.

See Also

xosd_display(3), xosd_show(3), xosd_hide(3).

                                                                                             XOSD_IS_ONSCREEN(3)

Synopsis

       #include <xosd.h>

       xosd *xosd_is_onscreen (xosd *osd);

See Also