.\"***************************************************************************
-.\" Copyright 2018-2021,2022 Thomas E. Dickey *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey *
.\" Copyright 2002-2015,2017 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_bkgrnd.3x,v 1.17 2022/06/25 21:57:59 tom Exp $
+.\" $Id: curs_bkgrnd.3x,v 1.20 2023/07/01 15:43:20 tom Exp $
.de bP
.ie n .IP \(bu 4
.el .IP \(bu 2
..
-.TH curs_bkgrnd 3X 2022-06-25 "ncurses 6.4" "Library calls"
+.TH curs_bkgrnd 3X 2023-07-01 "ncurses 6.4" "Library calls"
.SH NAME
\fBbkgrnd\fP,
\fBwbkgrnd\fP,
\fBgetbkgrnd\fP,
\fBwgetbkgrnd\fP \- \fBcurses\fP window complex background manipulation routines
.SH SYNOPSIS
-.PP
.B #include <curses.h>
.sp
\fBint bkgrnd(\fB const cchar_t *\fIwch\fB);\fR
\fBint getbkgrnd(cchar_t *\fIwch\fB);\fR
.br
\fBint wgetbkgrnd(WINDOW *\fIwin\fB, cchar_t *\fIwch\fB);\fR
-.br
.SH DESCRIPTION
.SS bkgrndset
-.PP
The \fBbkgrndset\fP and \fBwbkgrndset\fP routines manipulate the
background of the named window.
The window background is a \fBcchar_t\fP consisting of
particular terminal, the attribute part of the background is displayed
as the graphic rendition of the character put on the screen.
.SS bkgrnd
-.PP
The \fBbkgrnd\fP and \fBwbkgrnd\fP functions
set the background property of the current or specified window
and then apply this setting to every character position in that window:
Wherever the former background character
appears, it is changed to the new background character.
.SS getbkgrnd
-.PP
The \fBgetbkgrnd\fP function returns the given window's current background
character/attribute pair via the \fBwch\fP pointer.
If the given window pointer is null,
This implementation follows the approach used in SVr4 curses,
which is explained in the manual page for \fBwbkgd\fP.
.SH RETURN VALUE
-.PP
The \fBbkgrndset\fP and \fBwbkgrndset\fP routines do not return a value.
.PP
Upon successful completion, the other functions return \fBOK\fP.
.bP
A null character pointer is treated as an error.
.SH PORTABILITY
-.PP
These functions are described in the XSI Curses standard, Issue 4
(X/Open Curses).
.SH SEE ALSO