Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
curs_bkgd(3CURSES)	   Curses Library Functions	    curs_bkgd(3CURSES)

NAME
       curs_bkgd,  bkgd,  bkgdset,  wbkgdset, wbkgd - curses window background
       manipulation routines

SYNOPSIS
       cc [ flag ... ] file ...	-lcurses [ library ... ]
       #include	<curses.h>

       int bkgd(chtype ch);

       void bkgdset(chtype ch);

       void wbkgdset(WINDOW *win, chtype ch);

       int wbkgd(WINDOW	*win, chtype ch);

DESCRIPTION
       The bkgdsets() and wbkgdset() routines manipulate the background	of the
       named  window.  Background is a chtype consisting of any	combination of
       attributes and a	character. The attribute part  of  the	background  is
       combined	(ORed) 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 be-
       comes a property	of the character and moves with	the character  through
       any  scrolling  and insert/delete line/character	operations. To the ex-
       tent possible on	a particular terminal, the attribute part of the back-
       ground  is  displayed  as the graphic rendition of the character	put on
       the screen.

       The bkgd() and wbkgd() routines combine the new background  with	 every
       position	in the window. Background is any combination of	attributes and
       a character. Only the attribute part is used to set the	background  of
       non-blank characters,  while both character and attributes are used for
       blank positions.	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.

RETURN VALUES
       bkgd() and wbkgd() return the integer OK, or a non-negative integer, if
       immedok() is set. See curs_outopts(3CURSES).

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE	TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       curs_addch(3CURSES),    curs_outopts(3CURSES),	curses(3CURSES),   at-
       tributes(5)

NOTES
       The header <curses.h> automatically includes the	headers	 <stdio.h> and
       <unctrl.h>.

       Note that bkgdset() and bkgd() may be macros.

SunOS 5.10			  31 Dec 1996		    curs_bkgd(3CURSES)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ATTRIBUTES | SEE ALSO | NOTES

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=bkgd&sektion=3curses&manpath=SunOS+5.10>

home | help