1curs_bkgrnd(3X)                                                curs_bkgrnd(3X)
2
3
4

NAME

6       bkgrnd,  wbkgrnd, bkgrndset, wbkgrndset, getbkgrnd, wgetbkgrnd - curses
7       window complex background manipulation routines
8

SYNOPSIS

10       #include <curses.h>
11
12       int bkgrnd( const cchar_t *wch);
13       int wbkgrnd( WINDOW *win, const cchar_t *wch);
14
15       void bkgrndset(const cchar_t *wch );
16       void wbkgrndset(WINDOW *win, const cchar_t *wch);
17
18       int getbkgrnd(cchar_t *wch);
19       int wgetbkgrnd(WINDOW *win, cchar_t *wch);
20

DESCRIPTION

22   bkgrndset
23       The bkgrndset and wbkgrndset routines manipulate the background of  the
24       named  window.   The  window  background is a cchar_t consisting of any
25       combination of attributes (i.e., rendition) and  a  complex  character.
26       The  attribute part of the background is combined (OR'ed) with all non-
27       blank characters that are written into the window  with  waddch.   Both
28       the  character  and attribute parts of the background are combined with
29       the blank characters.  The background becomes a property of the charac‐
30       ter  and  moves  with  the  character  through  any  scrolling  and in‐
31       sert/delete line/character operations.
32
33       To the extent possible on a particular terminal, the attribute part  of
34       the  background  is displayed as the graphic rendition of the character
35       put on the screen.
36
37   bkgrnd
38       The bkgrnd and wbkgrnd functions set the  background  property  of  the
39       current  or specified window and then apply this setting to every char‐
40       acter position in that window:
41
42       •   The rendition of every character on the screen is  changed  to  the
43           new background rendition.
44
45       •   Wherever  the former background character appears, it is changed to
46           the new background character.
47
48   getbkgrnd
49       The getbkgrnd function returns the given  window's  current  background
50       character/attribute  pair  via  the  wch  pointer.  If the given window
51       pointer is null, the character is not updated (but no error returned).
52

NOTES

54       Note that bkgrnd, bkgrndset, and getbkgrnd may be macros.
55
56       X/Open Curses does not provide details on how the rendition is changed.
57       This  implementation follows the approach used in SVr4 curses, which is
58       explained in the manual page for wbkgd.
59

RETURN VALUE

61       The bkgrndset and wbkgrndset routines do not return a value.
62
63       Upon successful completion, the other functions return OK.   Otherwise,
64       they return ERR:
65
66       •   A null window pointer is treated as an error.
67
68       •   A null character pointer is treated as an error.
69

PORTABILITY

71       These  functions  are  described  in  the  XSI Curses standard, Issue 4
72       (X/Open Curses).
73

SEE ALSO

75       curses(3X), curs_bkgd(3X)
76
77
78
79                                                               curs_bkgrnd(3X)
Impressum