1notcurses_stdplane(3) notcurses_stdplane(3)
2
3
4
6 notcurses_stdplane - acquire the standard ncplane
7
8 SYNOPSIS
9 #include <notcurses/notcurses.h>
10
11 struct ncplane* notcurses_stdplane(struct notcurses* nc);
12
13 const struct ncplane* notcurses_stdplane_const(const struct notcurses*
14 nc);
15
16 static inline struct ncplane* notcurses_stddim_yx(struct notcurses* nc,
17 int* restrict y, int* restrict x);
18
19 static inline const struct ncplane* notcurses_stddim_yx_const(const
20 struct notcurses* nc, int* restrict y, int* restrict x);
21
23 notcurses_stdplane returns a handle to the standard ncplane for the
24 context nc. The standard plane always exists, and is always the same
25 size as the screen. It is an error to call ncplane_destroy(3), nc‐
26 plane_resize(3), or ncplane_move(3) on the standard plane, but it can
27 be freely moved along the z-axis.
28
29 notcurses_stddim_yx provides the same function, but also writes the di‐
30 mensions of the standard plane (and thus the real drawable area) into
31 any non-NULL parameters among y and x.
32
33 notcurses_stdplane_const allows a const notcurses to be safely used.
34
35 A resize event does not invalidate these references. They can be used
36 until notcurses_stop(3) is called on the associated nc.
37
39 These functions cannot fail when provided a valid struct notcurses.
40 They will always return a valid pointer to the standard plane.
41
43 notcurses(3), notcurses_plane(3), notcurses_stop(3)
44
46 nick black <nickblack@linux.com>.
47
48
49
50 v2.3.1 notcurses_stdplane(3)