|
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | PORTABILITY | SEE ALSO | COLOPHON |
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);
bkgdset
The bkgdset and wbkgdset routines manipulate the background of the
named window. The window background is a chtype consisting of any
combination of attributes (i.e., rendition) and a character. The
attribute part of the background is combined (OR'ed) with all non-
blank characters that are written into the window with waddch. Both
the character and attribute parts of the background are combined with
the blank characters. The background becomes a property of the
character and moves with the character through any scrolling and
insert/delete line/character operations.
To the extent possible on a particular terminal, the attribute part
of the background is displayed as the graphic rendition of the
character put on the screen.
bkgd
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.
· Wherever the former background character appears, it is changed
to the new background character.
getbkgd
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_outopts(3X)
This page is part of the ncurses (new curses) project. Information
about the project can be found at
⟨https://www.gnu.org/software/ncurses/ncurses.html⟩. If you have a
bug report for this manual page, send it to
bug-ncurses-request@gnu.org. This page was obtained from the
project's upstream Git mirror of the CVS repository
⟨git://ncurses.scripts.mit.edu/ncurses.git⟩ on 2017-07-05. If you
discover any rendering problems in this HTML version of the page, or
you believe there is a better or more up-to-date source for the page,
or you have corrections or improvements to the information in this
COLOPHON (which is not part of the original manual page), send a mail
to man-pages@man7.org
curs_bkgd(3X)