cursbkgrnd(3X) cursbkgrnd(3X)

NAME
       bbkkggrrnndd,  wwbbkkggrrnndd, bbkkggrrnnddsseett, wwbbkkggrrnnddsseett, ggeettbbkkggrrnndd, wwggeettbbkkggrrnndd - ccuurrsseess
       window complex background manipulation routines

SYNOPSIS
       ##iinncclluuddee <>

       iinntt bbkkggrrnndd(( ccoonnsstt cccchhaarrtt **wch));;
       iinntt wwbbkkggrrnndd(( WWIINNDDOOWW **win,, ccoonnsstt cccchhaarrtt **wch));;
       vvooiidd bbkkggrrnnddsseett((ccoonnsstt cccchhaarrtt **wch ));;
       vvooiidd wwbbkkggrrnnddsseett((WWIINNDDOOWW **win,, ccoonnsstt cccchhaarrtt **wch));;
       iinntt ggeettbbkkggrrnndd((cccchhaarrtt **wch));;
       iinntt wwggeettbbkkggrrnndd((WWIINNDDOOWW **win,, cccchhaarrtt **wch));;

DESCRIPTION
       The bbkkggrrnnddsseett and wwbbkkggrrnnddsseett routines manipulate the background of  the
       named  window.   The  window  background is a cccchhaarrtt consisting of any
       combination of attributes (i.e., rendition) and  a  complex  character.
       The  attribute part of the background is combined (OR'ed) with all non-
       blank characters that are written into the window  with  wwaaddddcchh.   Both
       the  character  and attribute parts of the background are combined with
       the blank characters.  The background becomes a property of the charac-
       ter   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.

       The bbkkggrrnndd and wwbbkkggrrnndd functions set the  background  property  of  the
       current  or specified window and then apply this setting to every char-
       acter 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 ggeettbbkkggrrnndd function returns the given  window's  current  background
       character/attribute pair via the wwcchh pointer.


NNOOTTEESS
       Note that bbkkggrrnndd, bbkkggrrnnddsseett, and ggeettbbkkggrrnndd may be macros.

RETURN VALUES
       The bbkkggrrnnddsseett and wwbbkkggrrnnddsseett routines do not return a value.

       Upon  successful completion, the other functions return OOKK.  Otherwise,
       they return EERRRR.  A null window pointer is treated as an error.

SEE ALSO
       ccuurrsseess(3X), ccuurrssbbkkggdd(3X)



                                                               cursbkgrnd(3X)