1curs_bkgd(3X)                                                    curs_bkgd(3X)
2
3
4

NAME

6       bkgdset,  wbkgdset,  bkgd,  wbkgd,  getbkgd  - curses window background
7       manipulation routines
8

SYNOPSIS

10       #include <curses.h>
11
12       void bkgdset(chtype ch);
13       void wbkgdset(WINDOW *win, chtype ch);
14       int bkgd(chtype ch);
15       int wbkgd(WINDOW *win, chtype ch);
16       chtype getbkgd(WINDOW *win);
17

DESCRIPTION

19   bkgdset
20       The bkgdset and wbkgdset routines  manipulate  the  background  of  the
21       named window.  The window background is a chtype consisting of any com‐
22       bination  of  attributes  (i.e.,  rendition)  and  a  character.    The
23       attribute part of the background is combined (OR'ed) with all non-blank
24       characters that are written into the  window  with  waddch.   Both  the
25       character  and  attribute parts of the background are combined with the
26       blank characters.  The background becomes a property of  the  character
27       and  moves  with  the character through any scrolling and insert/delete
28       line/character operations.
29
30       To the extent possible on a particular terminal, the attribute part  of
31       the  background  is displayed as the graphic rendition of the character
32       put on the screen.
33
34   bkgd
35       The bkgd and wbkgd functions set the background property of the current
36       or  specified  window  and  then  apply this setting to every character
37       position in that window:
38
39       ·   The rendition of every character on the screen is  changed  to  the
40           new background rendition.
41
42       ·   Wherever  the former background character appears, it is changed to
43           the new background character.
44
45   getbkgd
46       The getbkgd function returns  the  given  window's  current  background
47       character/attribute pair.
48

RETURN VALUE

50       The  routines  bkgd and wbkgd return the integer OK.  The SVr4.0 manual
51       says "or a non-negative integer if immedok is set", but this appears to
52       be an error.
53

NOTES

55       Note that bkgdset and bkgd may be macros.
56

PORTABILITY

58       These  functions are described in the XSI Curses standard, Issue 4.  It
59       specifies that bkgd and wbkgd return ERR on failure, but gives no fail‐
60       ure conditions.
61

SEE ALSO

63       curses(3X), curs_addch(3X), curs_attr(3X), curs_outopts(3X)
64
65
66
67                                                                 curs_bkgd(3X)
Impressum