cursoverlay(3X) cursoverlay(3X)

NAME
       oovveerrllaayy, oovveerrwwrriittee, ccooppyywwiinn - overlay and manipulate overlapped ccuurrsseess
       windows

SYNOPSIS
       ##iinncclluuddee <>

       iinntt oovveerrllaayy((ccoonnsstt WWIINNDDOOWW **ssrrccwwiinn,, WWIINNDDOOWW **ddssttwwiinn));;
       iinntt oovveerrwwrriittee((ccoonnsstt WWIINNDDOOWW **ssrrccwwiinn,, WWIINNDDOOWW **ddssttwwiinn));;
       iinntt ccooppyywwiinn((ccoonnsstt WWIINNDDOOWW **ssrrccwwiinn,, WWIINNDDOOWW **ddssttwwiinn,, iinntt ssmmiinnrrooww,,
             iinntt ssmmiinnccooll,, iinntt ddmmiinnrrooww,, iinntt ddmmiinnccooll,, iinntt ddmmaaxxrrooww,,
             iinntt ddmmaaxxccooll,, iinntt oovveerrllaayy));;

DESCRIPTION
       The oovveerrllaayy and oovveerrwwrriittee routines overlay srcwin  on  top  of  dstwin.
       scrwin and dstwin are not required to be the same size; only text where
       the two windows overlap is copied.  The difference is that  oovveerrllaayy  is
       non-destructive  (blanks  are not copied) whereas oovveerrwwrriittee is destruc-
       tive.

       The ccooppyywwiinn routine provides a finer granularity of  control  over  the
       oovveerrllaayy  and  oovveerrwwrriittee routines.  Like in the pprreeffrreesshh routine, a rec-
       tangle is specified in the destination window, (dminrow,  dmincol)  and
       (dmaxrow, dmaxcol), and the upper-left-corner coordinates of the source
       window, (sminrow, smincol).  If the  argument  overlay  is  ttrruuee,  then
       copying is non-destructive, as in oovveerrllaayy.

RREETTUURRNN VVAALLUUEE
       Routines  that  return an integer return EERRRR upon failure, and OOKK (SVr4
       only specifies "an integer value other than EERRRR") upon successful  com-
       pletion.

       X/Open  defines  no error conditions.  In this implementation, ccooppyywwiinn,
       oovveerrllaayy and oovveerrwwrriittee return an error if either of the window  pointers
       are null, or if some part of the window would be placed off-screen.

NNOOTTEESS
       Note that oovveerrllaayy and oovveerrwwrriittee may be macros.

PPOORRTTAABBIILLIITTYY
       The  XSI Curses standard, Issue 4 describes these functions (adding the
       const qualifiers).  It further specifies their behavior in the presence
       of  characters with multibyte renditions (not yet supported in this im-
       plementation).

SEE ALSO
       ccuurrsseess(3X), ccuurrssppaadd(3X), ccuurrssrreeffrreesshh(3X)



                                                              cursoverlay(3X)