File: xosd_set_shadow_offset.3

package info (click to toggle)
xosd 2.2.14-2.1
  • links: PTS
  • area: main
  • in suites: bullseye, buster, jessie, jessie-kfreebsd, sid, stretch
  • size: 2,320 kB
  • ctags: 409
  • sloc: sh: 10,748; ansic: 3,875; makefile: 77
file content (28 lines) | stat: -rw-r--r-- 918 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
.\" Hey Emacs! This file is -*- nroff -*- source.
.TH xosd_set_shadow_offset 3 "2002-06-25" "X OSD Library"
.SH NAME
xosd_set_shadow_offset \- Change the shadow-offset of the XOSD window
.SH SYNOPSIS
.B #include <xosd.h>
.sp
.BI "int xosd_set_shadow_offset (xosd* " osd ", int " shadow_offset );
.fi
.SH DESCRIPTION
To increase readability (and 'cos it looks cool) a black shadow is
drawn beneath the main XOSD window.
.B xosd_set_shadow_offset
changes the size of this shadow by altering how many pixels the shadow
is offset (to the bottom\-right) from the main display.
One to four pixels usually is sufficient to get a good effect.

.SH ARGUMENTS
.IP \fIosd\fP 1i
The on-screen display object to act on.
.IP \fIshadow_offset\fP 1i
Offset of black shadow from main text, in pixels.
.SH "RETURN VALUE"
On success, a zero is returned.
On error, \-1 is returned.
.SH "SEE ALSO"
.BR xosd_init (3),
.BR xosd_display (3).