bkgd(3X)

NAME

bkgd, bkgdset, getbkgd, wbkgd, wbkgdset — set or get background character and rendition using a single-byte character

SYNOPSIS

#include <curses.h>

int bkgd(chtype ch);

void bkgdset(chtype ch);

chtype getbkgd(WINDOW *win);

int wbkgd(WINDOW *win, chtype ch);

void wbkgdset(WINDOW *win, chtype ch);

DESCRIPTION

The bkgdset() and wbkgdset() functions set the background property of the current or specified window based on the information in ch. If ch refers to a multi-column character, the results are undefined.

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.

The getbkgd() function extracts the specified window's background character and rendition.

RETURN VALUE

Upon successful completion, bkgd() and wbkgd() return OK. Otherwise, they return ERR.

The bkgdset() and wbkgdset() functions do not return a value.

Upon successful completion, getbkgd() returns the specified window's background character and rendition. Otherwise, it returns (chtype)ERR.

ERRORS

No errors are defined.

APPLICATION USAGE

These functions are only guaranteed to operate reliably on character sets in which each character fits into a single byte, whose attributes can be expressed using only constants with the A_ prefix.

CHANGE HISTORY

First released in X/Open Curses, Issue 4.

bkgd(3X)

Technical documentation

» Table of Contents

» Index