From a43eab6921961765c9b9e6358cacdd3b9aad38f6 Mon Sep 17 00:00:00 2001 From: nick black Date: Sat, 28 Dec 2019 22:05:55 -0500 Subject: [PATCH] notcurses_newplane(3) man page #213 --- doc/man/man3/index.txt | 1 + doc/man/man3/notcurses_ncplane.3.ronn | 18 ++++++++++++++++++ doc/man/man3/notcurses_newplane.3.ronn | 21 +++++++++++++++++++++ 3 files changed, 40 insertions(+) create mode 100644 doc/man/man3/notcurses_newplane.3.ronn diff --git a/doc/man/man3/index.txt b/doc/man/man3/index.txt index 3b7be1826..8989a1141 100644 --- a/doc/man/man3/index.txt +++ b/doc/man/man3/index.txt @@ -2,6 +2,7 @@ notcurses(3) notcurses.3.ronn notcurses_init(3) notcurses_init.3.ronn notcurses_stdplane(3) notcurses_stdplane.3.ronn notcurses_ncplane(3) notcurses_ncplane.3.ronn +notcurses_newplane(3) notcurses_newplane.3.ronn notcurses_cell(3) notcurses_cell.3.ronn notcurses_input(3) notcurses_input.3.ronn notcurses_output(3) notcurses_output.3.ronn diff --git a/doc/man/man3/notcurses_ncplane.3.ronn b/doc/man/man3/notcurses_ncplane.3.ronn index 312a31873..c8b0204b4 100644 --- a/doc/man/man3/notcurses_ncplane.3.ronn +++ b/doc/man/man3/notcurses_ncplane.3.ronn @@ -6,23 +6,41 @@ notcurses_ncplane(3) -- operations on notcurses planes `#include ` `int ncplane_resize(struct ncplane* n, int keepy, int keepx, int keepleny, int keeplenx, int yoff, int xoff, int ylen, int xlen);` + `int ncplane_move_yx(struct ncplane* n, int y, int x);` + `void ncplane_yx(const struct ncplane* n, int* restrict y, int* restrict x);` + `int ncplane_set_default(struct ncplane* ncp, const cell* c);` + `int ncplane_default(struct ncplane* ncp, cell* c);` + `int ncplane_destroy(struct ncplane* ncp);` + `int ncplane_move_top(struct ncplane* n);` + `int ncplane_move_bottom(struct ncplane* n);` + `int ncplane_move_above(struct ncplane* n, struct ncplane* above);` + `int ncplane_move_below(struct ncplane* n, struct ncplane* below);` + `struct ncplane* ncplane_below(struct ncplane* n);` + `int ncplane_at_cursor(struct ncplane* n, cell* c);` + `int ncplane_at_yx(struct ncplane* n, int y, int x, cell* c);` + `void* ncplane_set_userptr(struct ncplane* n, void* opaque);` + `void* ncplane_userptr(struct ncplane* n);` + `const void* ncplane_userptr_const(const struct ncplane* n);` + `void ncplane_dim_yx(const struct ncplane* n, int* restrict rows, int* restrict cols);` + `int ncplane_cursor_move_yx(struct ncplane* n, int y, int x);` + `void ncplane_cursor_yx(const struct ncplane* n, int* restrict y, int* restrict x);` ## DESCRIPTION diff --git a/doc/man/man3/notcurses_newplane.3.ronn b/doc/man/man3/notcurses_newplane.3.ronn new file mode 100644 index 000000000..07abc28f0 --- /dev/null +++ b/doc/man/man3/notcurses_newplane.3.ronn @@ -0,0 +1,21 @@ +notcurses_newplane(3) -- create a new ncplane atop the z-buffer +=============================================================== + +## SYNOPSIS + +`#include ` + +`struct ncplane* notcurses_newplane(struct notcurses* nc, int rows, int cols, int yoff, int xoff, void* opaque);` + +## DESCRIPTION + + +## RETURN VALUES + +## AUTHORS + +Nick Black + +## SEE ALSO + +notcurses_ncplane(3), notcurses_stdplane(3)