curs_bkgd(S-osr5)

curs_bkgd: bkgdset, wbkgdset, bkgd, wbkgd -- curses window background manipulation routines

Syntax

cc ... -lcurses

#include <curses.h>

void bkgdset(chtype ch);
void wbkgdset(WINDOW *win, chtype ch);
int bkgd(chtype ch);
int wbkgd(WINDOW *win, chtype ch);

Description

The routines bkgdset(S-osr5) and wbkgdset(S-osr5) manipulate the background of the specified window. Background is a chtype consisting of any combination of attributes and a character.

The attribute part of the background is combined (ORed) with all non-blank characters that are written into the window with waddch(S-osr5). Both the character 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 terminal, the attribute part of the background is displayed as the graphic rendition of the character put on the screen.

The routines bkgd(S-osr5) and wbkgd(S-osr5) combine the new background with every position in the window. Background is any combination of attributes and a character. Only the attribute part is used to set the background of non-blank 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.

Return values

bkgd( ) and wbkgd( ) return the integer OK, or a non-negative integer, if immedok(S-osr5) is set.

Warning

The header file curses.h automatically includes the header files stdio.h and unctrl.h.

The following can be macros: bkgdset( ) and bkgd( ).

Files

/usr/lib/libcurses.a: the library

Standards conformance

bkgdset(S-osr5), wbkgdset(S-osr5), bkgd(S-osr5), and wbkgd(S-osr5) are not part of any currently supported standard; they are extensions of AT&T System V developed by The Santa Cruz Operation, Inc. and maintained by The SCO Group.