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

RETURN VALUE

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

NOTES

52       Note that bkgdset and bkgd may be macros.
53

PORTABILITY

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

SEE ALSO

60       curses(3X), curs_addch(3X), curs_attr(3X), curs_outopts(3X)
61
62
63
64                                                                 curs_bkgd(3X)
Impressum