curses_background(3)
- NetBSD Manual Pages
CURSES_BACKGROUND(3) NetBSD Library Functions Manual CURSES_BACKGROUND(3)
NAME
curses_background, bkgd, bkgdset, getbkgd, wbkgd, wbkgdset - curses
attribute manipulation routines
LIBRARY
Curses Library (libcurses, -lcurses)
SYNOPSIS
#include <curses.h>
int
bkgd(chtype);
int
bkgdset(chtype);
chtype
getbkgd(WINDOW *);
int
wbkgd(chtype);
int
wbkgdset(chtype);
DESCRIPTION
These functions manipulate the background attributes on stdscr or on the
specified window.
The function wbkgdset(win, ch) sets the background attributes of the
specified window win to ch.
The function wbkgd(win, ch) sets the background attributes of the speci-
fied window win to ch and also sets the background attribute of every
character position on that window.
The functions bkgdset(ch) and bkgd(ch) are equivalent to wbkgdset(stdscr,
ch) and wbkgd(stdscr, ch), respectively.
When the background attributes are set on a window, characters are ren-
dered with the logical OR of the background attributes and the charac-
ter's attributes. If both the background attribute and the character
attribute contain color, the color of the character attribute is dis-
played. If the background attribute contains a non-space character, then
this character is rendered where the foreground character is a space
character.
The function getbkgd(win) returns the background attributes for the win-
dow win.
RETURN VALUES
The functions wbkgdset() and wbkgd() return OK on success and ERR on
failure.
SEE ALSO
curses_attributes(3), curses_color(3)
STANDARDS
The NetBSD Curses library complies with the X/Open Curses specification,
part of the Single Unix Specification.
HISTORY
These functions first appeared in NetBSD 1.6.
NetBSD 2.0 October 13, 2002 NetBSD 2.0
Powered by man-cgi (2024-03-20).
Maintained for NetBSD
by Kimmo Suominen.
Based on man-cgi by Panagiotis Christias.