*** UNIX MANUAL PAGE BROWSER ***

curs_bkgd(3) Library Functions Manual curs_bkgd(3) NAME curs_bkgd, bkgd, wbkgd, bkgdset, wbkgdset, getbkgd - Routines for ma- nipulating the background in a Curses window LIBRARY Curses Library (libcurses.a, libcurses.so) SYNOPSIS #include <curses.h> int bkgd(chtype ch); int wbkgd(WINDOW *win, chtype ch); void bkgdset(chtype ch); void wbkgdset(WINDOW *win, chtype ch); chtype get- bkgd(WINDOW *win); STANDARDS Interfaces documented on this reference page conform to industry stan- dards as follows: bkgd, wbkgd, bkgdset, wbkgdset, getbkgd: XPG4-UNIX Refer to the standards(5) reference page for more information about in- dustry standards and associated tags. DESCRIPTION The bkgdset and wbkgdset routines manipulate the background of the named window. Background is defined as chtype and consists of any com- bination of attributes and a character. The attribute part of the background is combined (by using an inclusive OR operation) with all nonblank characters that waddch writes into the window. Both the char- acter and attribute parts of the background are combined with the blank characters. The background becomes a property of the character and moves with the character through any scrolling and insert/delete line/character operations. To the extent possible on a particular ter- minal, the attribute part of the background is displayed as the graphic rendition of the character put on the screen. The bkgd and wbkgd routines combine the new background with every posi- tion in the window. Background is any combination of attributes and a character. Only the attribute part is used to set the background of nonblank characters, while both character and attributes are used for blank positions. To the extent possible on a particular terminal, the attribute part of the background is displayed as the graphic rendition of the character put on the screen. The getbkgd routine returns the background character and attributes, encoded in a chtype data element, for the specified window. NOTES The header file curses.h automatically includes the header file stdio.h. Note that bkgdset and bkgd may be macros. RETURN VALUES The bkgd and wbkgd routines return OK on success or ERR on failure. The wbkgdset and wbkgdset routines have no return value. The getbkgd routine returns the background character and its rendition on success or ERR on failure. RELATED INFORMATION Functions: curses(3), curs_addch(3), curs_bkgrnd(3), curs_outopts(3) Others: standards(5) delim off curs_bkgd(3)