From 43f0a2e5c8b17d4e92c19c457c3a94fe62f33ce7 Mon Sep 17 00:00:00 2001 From: nick black Date: Mon, 5 Jul 2021 23:39:42 -0400 Subject: [PATCH] remove false comments on ncplane_move_yx() --- USAGE.md | 2 +- doc/man/man3/notcurses_plane.3.md | 6 ++++++ include/notcurses/notcurses.h | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/USAGE.md b/USAGE.md index bad3ceac5..27546b9c2 100644 --- a/USAGE.md +++ b/USAGE.md @@ -914,7 +914,7 @@ ncplane_resize_simple(struct ncplane* n, int ylen, int xlen){ // Move this plane relative to the standard plane, or the plane to which it is // bound (if it is bound to a plane). It is an error to attempt to move the -// standard plane. Specifying a coordinate as -1 will hold it constant. +// standard plane. int ncplane_move_yx(struct ncplane* n, int y, int x); // Move this plane relative to its current location. Negative values move up diff --git a/doc/man/man3/notcurses_plane.3.md b/doc/man/man3/notcurses_plane.3.md index 38015f5c3..56332c726 100644 --- a/doc/man/man3/notcurses_plane.3.md +++ b/doc/man/man3/notcurses_plane.3.md @@ -279,6 +279,12 @@ to multiple ncplanes. So long as all threads are readers, multiple threads may work with a single ncplane. A reading function is any which accepts a **const struct ncplane**. +A plane can be moved relative to its parent plane's origin with +**ncplane_move_yx**. If the plane has no parent, the move is relative to +the rendering area. A plane can be moved off-screen entirely, in which case +it will not be visible following rasterization; it can also be partially +off-screen. + A plane has a virtual cursor; move it with **ncplane_cursor_move_yx**. Specifying -1 as one or both coordinates will hold that axis constant. Unless coordinates are specified for a call, action takes place at the plane's diff --git a/include/notcurses/notcurses.h b/include/notcurses/notcurses.h index 6a6cd580a..e0fbdedf3 100644 --- a/include/notcurses/notcurses.h +++ b/include/notcurses/notcurses.h @@ -1499,7 +1499,7 @@ API int ncplane_x(const struct ncplane* n) __attribute__ ((pure)); // Move this plane relative to the standard plane, or the plane to which it is // bound (if it is bound to a plane). It is an error to attempt to move the -// standard plane. Specifying a coordinate as -1 will hold it constant. +// standard plane. API int ncplane_move_yx(struct ncplane* n, int y, int x); // Move this plane relative to its current location. Negative values move up