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
27       •   The attribute part of the background is combined (OR'ed)  with  all
28           non-blank characters that are written into the window with waddch.
29
30       •   Both  the  character and attribute parts of the background are com‐
31           bined with the blank characters.
32
33       The background becomes a property of the character and moves  with  the
34       character through any scrolling and insert/delete line/character opera‐
35       tions.
36
37       To the extent possible on a particular terminal, the attribute part  of
38       the  background  is displayed as the graphic rendition of the character
39       put on the screen.
40
41   bkgrnd
42       The bkgrnd and wbkgrnd functions set the  background  property  of  the
43       current  or specified window and then apply this setting to every char‐
44       acter position in that window:
45
46       •   The rendition of every character on the screen is  changed  to  the
47           new background rendition.
48
49       •   Wherever  the former background character appears, it is changed to
50           the new background character.
51
52   getbkgrnd
53       The getbkgrnd function returns the given  window's  current  background
54       character/attribute  pair  via  the  wch  pointer.  If the given window
55       pointer is null, the character is not updated (but no error returned).
56

NOTES

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

RETURN VALUE

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

PORTABILITY

75       These  functions  are  described  in  the  XSI Curses standard, Issue 4
76       (X/Open Curses).
77

SEE ALSO

79       curses(3X), curs_bkgd(3X)
80
81
82
83                                                               curs_bkgrnd(3X)
Impressum