xosd_set_vertical_offset — Change the vertical offset of the XOSD window
#include <xosd.h>
int xosd_set_vertical_offset( | xosd * | osd, |
int | offset) ; |
xosd_set_vertical_offset changes the number of pixels the XOSD window is offset from the top or bottom of the display. This is done to avoid desktop-panels, such as those provided by GNOME or KDE. By default the vertical offset is zero; a value of 48 will generally avoid most panels.
The direction the XOSD window is offset depends on the vertical positioning of the window (set by calling xosd_set_pos(3xosd))
If the XOSD window is at the top of the display (XOSD_top) then xosd_set_vertical_offset moves the window down by offset pixels.
If the XOSD window is at the bottom of the display (XOSD_bottom) then xosd_set_vertical_offset moves the window up by offset pixels.
The XOSD window to change.
The number of pixels the XOSD window is offset from the top of bottom of the display.
On success, a zero is returned. On error, -1 is returned and xosd_error is set to indicate the reason for the error.
A string describing the error, if one occurred.
The xosd_set_pos(3xosd) function is used to change the vertical position of the XOSD window. This, in turn, affects the how xosd_set_vertical_offset works.
The XOSD library was originally written by André Renaud, and is currently maintained by Tim Wright. This document was written by Michael JasonSmith.
If the vertical position of the XOSD window is set to the middle of the display (XOSD_middle) then xosd_set_vertical_offset behaves strangely. Bug reports can be sent to <xosd@ignavus.net>.