mirror of
https://github.com/dankamongmen/notcurses.git
synced 2024-11-06 03:20:26 +00:00
37 lines
987 B
Markdown
37 lines
987 B
Markdown
notcurses_stdplane(3) -- acquire the standard ncplane
|
|
=====================================================
|
|
|
|
## SYNOPSIS
|
|
|
|
`#include <notcurses.h>`
|
|
|
|
`struct ncplane*
|
|
notcurses_stdplane(struct notcurses* nc);`
|
|
|
|
`const struct ncplane*
|
|
notcurses_const_stdplane(const struct notcurses* nc);`
|
|
|
|
## DESCRIPTION
|
|
|
|
`notcurses_stdplane` returns a handle to the standard ncplane for the context
|
|
`nc`. The standard plane always exists, and is always the same size as the
|
|
screen. It is an error to call `ncplane_destroy(3)`, `ncplane_resize(3)`, or
|
|
`ncplane_move(3)` on the standard plane, though it can be freely moved along
|
|
the z-axis.
|
|
|
|
A resize event does not invalidate this reference; it can be used until
|
|
`notcurses_stop(3)` is called on `nc`.
|
|
|
|
## RETURN VALUES
|
|
|
|
These functions cannot fail when provided a valid `struct notcurses*`. They
|
|
will always return a valid pointer to the standard plane.
|
|
|
|
## AUTHOR
|
|
|
|
Nick Black <nickblack@linux.com>
|
|
|
|
## SEE ALSO
|
|
|
|
notcurses_ncplane(3), notcurses_stop(3)
|