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       void bkgrndset(const cchar_t *wch );
15       void wbkgrndset(WINDOW *win, const cchar_t *wch);
16       int getbkgrnd(cchar_t *wch);
17       int wgetbkgrnd(WINDOW *win, cchar_t *wch);
18

DESCRIPTION

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

NOTES

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

RETURN VALUE

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

PORTABILITY

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

SEE ALSO

73       curses(3X), curs_bkgd(3X)
74
75
76
77                                                               curs_bkgrnd(3X)
Impressum