X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_bkgd.3x.html;h=81cdf90cf26111ceb7303bca27359d3f441f91d7;hb=c885a3fdd089f784f17dd2e9c03d8eb774072dc9;hp=8778b6a7b465d2f996e88a0108189b33c165601e;hpb=b0b1980be11bba618d84beb8b30ac94e2c820602;p=ncurses.git diff --git a/doc/html/man/curs_bkgd.3x.html b/doc/html/man/curs_bkgd.3x.html index 8778b6a7..81cdf90c 100644 --- a/doc/html/man/curs_bkgd.3x.html +++ b/doc/html/man/curs_bkgd.3x.html @@ -1,7 +1,6 @@ - +
+ +- curs_bkgd(3x) curs_bkgd(3x) --
+
bkgdset, wbkgdset, bkgd, wbkgd, getbkgd - curses window background manipulation routines --
+
#include <curses.h> - void bkgdset(chtype ch); - void wbkgdset(WINDOW *win, chtype ch); - int bkgd(chtype ch); - int wbkgd(WINDOW *win, chtype ch); - chtype getbkgd(WINDOW *win); + void bkgdset(chtype ch); + void wbkgdset(WINDOW *win, chtype ch); + int bkgd(chtype ch); + int wbkgd(WINDOW *win, chtype ch); + chtype getbkgd(WINDOW *win); --
+
+ +
The bkgdset and wbkgdset routines manipulate the back- ground of the named window. The window background is a chtype consisting of any combination of attributes (i.e., @@ -80,49 +79,64 @@ attribute part of the background is displayed as the graphic rendition of the character put on the screen. + +
The bkgd and wbkgd functions set the background property of the current or specified window and then apply this setting to every character position in that window: - The rendition of every character on the screen is - changed to the new background rendition. + o The rendition of every character on the screen is + changed to the new background rendition. + + o Wherever the former background character appears, it + is changed to the new background character. - Wherever the former background character appears, - it is changed to the new background character. +
The getbkgd function returns the given window's current background character/attribute pair. --
+
The routines bkgd and wbkgd return the integer OK. The SVr4.0 manual says "or a non-negative integer if immedok is set", but this appears to be an error. --
+
Note that bkgdset and bkgd may be macros. --
+
These functions are described in the XSI Curses standard, Issue 4. It specifies that bkgd and wbkgd return ERR on failure, but gives no failure conditions. --
- curses(3x), curs_addch(3x), curs_attr(3x), curs_out- +
+ curses(3x), curs_addch(3x), curs_attr(3x), curs_out- opts(3x) curs_bkgd(3x)-