man7.org > Linux > man-pages

Linux/UNIX system programming training

curs_overlay(3x) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | PORTABILITY | SEE ALSO | COLOPHON 

curs_overlay(3X)              Library calls              curs_overlay(3X)

NAME         top

       overlay, overwrite, copywin - overlay curses windows and
       manipulate them

SYNOPSIS         top

       #include <curses.h>

       int overlay(const WINDOW *srcwin, WINDOW *dstwin);
       int overwrite(const WINDOW *srcwin, WINDOW *dstwin);
       int copywin(const WINDOW *srcwin, WINDOW *dstwin, int sminrow,
             int smincol, int dminrow, int dmincol, int dmaxrow,
             int dmaxcol, int overlay);

DESCRIPTION         top

   overlay, overwrite
       The overlay and overwrite 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 overlay is non-destructive (blanks are not copied) whereas
       overwrite is destructive.

   copywin
       The copywin routine provides a finer granularity of control over
       the overlay and overwrite routines.  As in the prefresh routine, a
       rectangle 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 true, then copying is non-destructive, as in
       overlay.

RETURN VALUE         top

       These functions return OK on success and ERR on failure.

       In ncurses, they return ERR if

       •   either of the window pointers are null, or

       •   any part of the window would be placed off-screen.

NOTES         top

       overlay and overwrite may be implemented as macros.

PORTABILITY         top

       X/Open Curses Issue 4 describes these functions.  It specifies no
       error conditions for them.  It adds const qualifiers to the
       arguments.  It further specifies their behavior in the presence of
       characters with multibyte renditions (not yet supported in this
       implementation).

       SVr4 describes a successful return value only as “an integer value
       other than ERR”.

SEE ALSO         top

       curses(3X), curs_pad(3X), curs_refresh(3X)

COLOPHON         top

       This page is part of the ncurses (new curses) project.
       Information about the project can be found at 
       ⟨https://invisible-island.net/ncurses/ncurses.html⟩.  If you have a
       bug report for this manual page, send it to bug-ncurses@gnu.org.
       This page was obtained from the tarball ncurses-6.6.tar.gz fetched
       from ⟨https://ftp.gnu.org/gnu/ncurses/⟩ on 2026-01-16.  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for the
       page, or you have corrections or improvements to the information
       in this COLOPHON (which is not part of the original manual page),
       send a mail to man-pages@man7.org

ncurses @NCURSES_MAJOR@.@NCU... 2025-01-18               curs_overlay(3X)

HTML rendering created 2026-01-16 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI