blackbeard420/notcurses
1
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses synced 2025-03-09 17:19:03 -04:00
Code Issues Projects Releases Wiki Activity

notcurses_plane.3: add section about bindings

Browse Source
This commit is contained in:
nick black 2021-10-05 02:09:40 -04:00 committed by nick black
parent 20fb846fbc
commit cadd5f75fb
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/man/man3/notcurses.3.md
View File

@ -154,7 +154,7 @@ not itself perform any locking.
* It is **not** safe to add, delete, or reorder ncplanes within a single pile
from multiple threads.
Only one thread may call **notcurses_getc** or any other input-related thread
Only one thread may call **notcurses_get(3)** or any other input-related thread
at a time, but it **is** safe to call for input while another thread renders.
Since multiple threads can concurrently manipulate distinct ncplanes, peak

12
doc/man/man3/notcurses_plane.3.md
View File

@ -396,9 +396,17 @@ When a plane is moved to a different pile (whether new or preexisting), any
planes which were bound to it are rebound to its previous parent. If the plane
was a root plane of some pile, any bound planes become root planes. The new
plane is placed immediately atop its new parent on its new pile's z-axis.
When `ncplane_reparent_family()` is used, all planes bound to the reparented
When **ncplane_reparent_family** is used, all planes bound to the reparented
plane are moved along with it. Their relative z-order is maintained.
## Binding
The planes of a pile make up a directed acyclic forest. Planes bound to
themselves make up the root planes of the pile. Every plane is either a
root plane, or bound to some other plane in its pile. A plane and its
descendants make up a family. When a plane is moved using **ncplane_move_yx**,
its family is moved along with it.
## Scrolling
All planes, including the standard plane, are created with scrolling disabled.
@ -503,7 +511,7 @@ It should not be used in new code.
# BUGS
**ncplane_at_yx** doesn't yet account for bitmap-based graphics (see
**notcurses_visual**). Whatever glyph-based contents existed on the plane when
**notcurses_visual(3)**). Whatever glyph-based contents existed on the plane when
the bitmap was blitted will continue to be returned.
When the alternate screen is not used (see **notcurses_init(3)**), the contents