.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "notcurses_stdplane" "3" "v2.0.4" "" ""
.hy
.SH NAME
.PP
notcurses_stdplane - acquire the standard ncplane
.SS SYNOPSIS
.PP
\f[B]#include <notcurses/notcurses.h>\f[R]
.PP
\f[B]struct ncplane* notcurses_stdplane(struct notcurses*
\f[R]\f[I]nc\f[R]\f[B]);\f[R]
.PP
\f[B]const struct ncplane* notcurses_stdplane_const(const struct
notcurses* \f[R]\f[I]nc\f[R]\f[B]);\f[R]
.PP
\f[B]static inline struct ncplane* notcurses_stddim_yx(struct notcurses*
\f[R]\f[I]nc\f[R]\f[B], int* restrict \f[R]\f[I]y\f[R]\f[B], int*
restrict \f[R]\f[I]x\f[R]\f[B]);\f[R]
.PP
\f[B]static inline const struct ncplane* notcurses_stddim_yx_const(const
struct notcurses* \f[R]\f[I]nc\f[R]\f[B], int* restrict
\f[R]\f[I]y\f[R]\f[B], int* restrict \f[R]\f[I]x\f[R]\f[B]);\f[R]
.SH DESCRIPTION
.PP
\f[B]notcurses_stdplane\f[R] returns a handle to the standard ncplane
for the context \f[B]nc\f[R].
The standard plane always exists, and is always the same size as the
screen.
It is an error to call \f[B]ncplane_destroy(3)\f[R],
\f[B]ncplane_resize(3)\f[R], or \f[B]ncplane_move(3)\f[R] on the
standard plane, but it can be freely moved along the z-axis.
.PP
\f[B]notcurses_stddim_yx\f[R] provides the same function, but also
writes the dimensions of the standard plane (and thus the real drawable
area) into any non-\f[B]NULL\f[R] parameters among \f[B]y\f[R] and
\f[B]x\f[R].
.PP
\f[B]notcurses_stdplane_const\f[R] allows a \f[B]const notcurses\f[R] to
be safely used.
.PP
A resize event does not invalidate these references.
They can be used until \f[B]notcurses_stop(3)\f[R] is called on the
associated \f[B]nc\f[R].
.SH RETURN VALUES
.PP
These functions cannot fail when provided a valid \f[B]struct
notcurses\f[R].
They will always return a valid pointer to the standard plane.
.SH SEE ALSO
.PP
\f[B]notcurses(3)\f[R], \f[B]notcurses_plane(3)\f[R],
\f[B]notcurses_stop(3)\f[R]
.SH AUTHORS
nick black <nickblack@linux.com>.