1curs_bkgd(3CURSES)         Curses Library Functions         curs_bkgd(3CURSES)
2
3
4

NAME

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

SYNOPSIS

10       cc [ flag ... ] file ... -lcurses [ library ... ]
11       #include <curses.h>
12
13       int bkgd(chtype ch);
14
15
16       void bkgdset(chtype ch);
17
18
19       void wbkgdset(WINDOW *win, chtype ch);
20
21
22       int wbkgd(WINDOW *win, chtype ch);
23
24

DESCRIPTION

26       The bkgdsets() and wbkgdset() routines manipulate the background of the
27       named  window.  Background is a chtype consisting of any combination of
28       attributes and a character. The attribute part  of  the  background  is
29       combined (ORed) with all non-blank characters that are written into the
30       window  with waddch(). Both the character and attribute  parts  of  the
31       background  are  combined  with  the  blank  characters. The background
32       becomes a property of  the  character  and  moves  with  the  character
33       through  any  scrolling and insert/delete line/character operations. To
34       the extent possible on a particular terminal, the attribute part of the
35       background  is  displayed as the graphic rendition of the character put
36       on the screen.
37
38
39       The bkgd() and wbkgd() routines combine the new background  with  every
40       position in the window. Background is any combination of attributes and
41       a character. Only the attribute part is used to set the  background  of
42       non-blank characters,  while both character and attributes are used for
43       blank positions. To the extent possible on a particular  terminal,  the
44       attribute  part of the background is displayed as the graphic rendition
45       of the character put on the screen.
46

RETURN VALUES

48       bkgd() and wbkgd() return the integer OK, or a non-negative integer, if
49       immedok() is set. See curs_outopts(3CURSES).
50

ATTRIBUTES

52       See attributes(5) for descriptions of the following attributes:
53
54
55
56
57       ┌─────────────────────────────┬─────────────────────────────┐
58       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
59       ├─────────────────────────────┼─────────────────────────────┤
60       │MT-Level                     │Unsafe                       │
61       └─────────────────────────────┴─────────────────────────────┘
62

SEE ALSO

64       curs_addch(3CURSES),       curs_outopts(3CURSES),      curses(3CURSES),
65       attributes(5)
66

NOTES

68       The header <curses.h> automatically includes the headers  <stdio.h> and
69       <unctrl.h>.
70
71
72       Note that bkgdset() and bkgd() may be macros.
73
74
75
76SunOS 5.11                        31 Dec 1996               curs_bkgd(3CURSES)
Impressum