4 <STRONG>bkgdset</STRONG>, <STRONG>wbkgdset</STRONG>, <STRONG>bkgd</STRONG>, <STRONG>wbkgd</STRONG> - <STRONG>curses</STRONG> window background
10 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
12 <STRONG>void</STRONG> <STRONG>bkgdset(const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
13 <STRONG>void</STRONG> <STRONG>wbkgdset(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
14 <STRONG>int</STRONG> <STRONG>bkgd(const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
15 <STRONG>int</STRONG> <STRONG>wbkgd(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
16 <STRONG>chtype</STRONG> <STRONG>getbkgd(WINDOW</STRONG> <STRONG>*win);</STRONG>
20 <H2>DESCRIPTION</H2><PRE>
21 The <STRONG>bkgdset</STRONG> and <STRONG>wbkgdset</STRONG> routines manipulate the back-
22 ground of the named window. The window background is a
23 <STRONG>chtype</STRONG> consisting of any combination of attributes (i.e.,
24 rendition) and a character. The attribute part of the
25 background is combined (OR'ed) with all non-blank charac-
26 ters that are written into the window with <STRONG>waddch</STRONG>. Both
27 the character and attribute parts of the background are
28 combined with the blank characters. The background
29 becomes a property of the character and moves with the
30 character through any scrolling and insert/delete
31 line/character operations.
33 To the extent possible on a particular terminal, the
34 attribute part of the background is displayed as the
35 graphic rendition of the character put on the screen.
37 The <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> functions set the background property
38 of the current or specified window and then apply this
39 setting to every character position in that window:
41 The rendition of every character on the screen is
42 changed to the new background rendition.
44 Wherever the former background character appears,
45 it is changed to the new background character.
47 The <STRONG>getbkgd</STRONG> function returns the given window's current
48 background character/attribute pair.
52 <H2>RETURN VALUE</H2><PRE>
53 The routines <STRONG>bkgd</STRONG> and <STRONG>wbkgd</STRONG> return the integer <STRONG>OK</STRONG>. The
54 SVr4.0 manual says "or a non-negative integer if <STRONG>immedok</STRONG>
55 is set", but this appears to be an error.
60 Note that <STRONG>bkgdset</STRONG> and <STRONG>bkgd</STRONG> may be macros.
64 <H2>PORTABILITY</H2><PRE>
65 These functions are described in the XSI Curses standard,
66 return <STRONG>ERR</STRONG>, on failure. but gives no failure conditions.
70 <H2>SEE ALSO</H2><PRE>
71 <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3X)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3X)</A></STRONG>