.\"***************************************************************************
-.\" Copyright 2018,2020 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.11 2020/02/02 23:34:34 tom Exp $
+.\" $Id: curs_bkgrnd.3x,v 1.27 2023/09/16 23:34:43 tom Exp $
+.TH curs_bkgrnd 3X 2023-09-16 "ncurses 6.4" "Library calls"
.de bP
.ie n .IP \(bu 4
.el .IP \(bu 2
..
-.TH curs_bkgrnd 3X ""
.SH NAME
-\fBbkgrnd\fR,
-\fBwbkgrnd\fR,
-\fBbkgrndset\fR,
-\fBwbkgrndset\fR,
-\fBgetbkgrnd\fR,
-\fBwgetbkgrnd\fR \- \fBcurses\fR window complex background manipulation routines
+\fB\%bkgrnd\fP,
+\fB\%wbkgrnd\fP,
+\fB\%bkgrndset\fP,
+\fB\%wbkgrndset\fP,
+\fB\%getbkgrnd\fP,
+\fB\%wgetbkgrnd\fP \-
+manipulate background of a \fIcurses\fP window of wide characters
.SH SYNOPSIS
-.PP
-.B #include <curses.h>
+\fB#include <curses.h>\fR
.sp
-\fBint bkgrnd(\fR\fB const cchar_t *\fR\fIwch\fR\fB);\fR
-.br
-\fBint wbkgrnd(\fR\fB WINDOW *\fR\fIwin\fR\fB, const cchar_t *\fR\fIwch\fR\fB);\fR
-.br
-\fBvoid bkgrndset(const cchar_t *\fR\fIwch\fR \fB);\fR
-.br
-\fBvoid wbkgrndset(WINDOW *\fR\fIwin\fR\fB, const cchar_t *\fR\fIwch\fR\fB);\fR
+\fBint bkgrnd(\fBconst cchar_t *\fIwch\fB);\fR
.br
-\fBint getbkgrnd(cchar_t *\fR\fIwch\fR\fB);\fR
+\fBint wbkgrnd(\fBWINDOW *\fIwin\fB, const cchar_t *\fIwch\fB);\fR
+.sp
+\fBvoid bkgrndset(const cchar_t *\fIwch\fR \fB);\fR
.br
-\fBint wgetbkgrnd(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwch\fR\fB);\fR
+\fBvoid wbkgrndset(WINDOW *\fIwin\fB, const cchar_t *\fIwch\fB);\fR
+.sp
+\fBint getbkgrnd(cchar_t *\fIwch\fB);\fR
.br
+\fBint wgetbkgrnd(WINDOW *\fIwin\fB, cchar_t *\fIwch\fB);\fR
.SH DESCRIPTION
.SS bkgrndset
-.PP
-The \fBbkgrndset\fR and \fBwbkgrndset\fR routines manipulate the
+The \fBbkgrndset\fP and \fBwbkgrndset\fP routines manipulate the
background of the named window.
-The window background is a \fBcchar_t\fR consisting of
+The window background is a \fBcchar_t\fP consisting of
any combination of attributes (i.e., rendition) and a complex character.
+.bP
The attribute part of the background is combined (OR'ed) with all non-blank
-characters that are written into the window with \fBwaddch\fR.
+characters that are written into the window with \fBwaddch\fP.
+.bP
Both
the character and attribute parts of the background are combined with
the blank characters.
+.PP
The background becomes a property of the
character and moves with the character through any scrolling and
insert/delete line/character operations.
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\fR and \fBwbkgrnd\fR functions
+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:
.bP
Wherever the former background character
appears, it is changed to the new background character.
.SS getbkgrnd
-.PP
-The \fBgetbkgrnd\fR function returns the given window's current background
-character/attribute pair via the \fBwch\fR pointer.
+The \fBgetbkgrnd\fP function returns the given window's current background
+character/attribute pair via the
+.I wch
+pointer.
If the given window pointer is null,
-the character is not updated (but no error returned).
+the character is not updated (but no error is returned).
.SH NOTES
Note that
-\fBbkgrnd\fR,
-\fBbkgrndset\fR, and
-\fBgetbkgrnd\fR
+\fBbkgrnd\fP,
+\fBbkgrndset\fP, and
+\fBgetbkgrnd\fP
may be macros.
.PP
X/Open Curses does not provide details on how the rendition is changed.
This implementation follows the approach used in SVr4 curses,
which is explained in the manual page for \fBwbkgd\fP.
.SH RETURN VALUE
+The \fBbkgrndset\fP and \fBwbkgrndset\fP routines do not return a value.
.PP
-The \fBbkgrndset\fR and \fBwbkgrndset\fR routines do not return a value.
-.PP
-Upon successful completion, the other functions return \fBOK\fR.
-Otherwise, they return \fBERR\fR:
+Upon successful completion, the other functions return \fBOK\fP.
+Otherwise, they return \fBERR\fP:
.bP
A null window pointer is treated as an error.
.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
-\fBcurses\fR(3X),
-\fBcurs_bkgd\fR(3X)
+\fBcurses\fP(3X),
+\fBcurs_bkgd\fP(3X)
projects / ncurses.git / blobdiff