blackbeard420/notcurses
1
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses synced 2025-03-10 01:29:05 -04:00
Code Issues Projects Releases Wiki Activity

man page syntax

Browse Source
This commit is contained in:
nick black 2021-12-09 18:33:13 -05:00 committed by nick black
parent e061686eda
commit 1f713c4e47
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -109,20 +109,20 @@ is assumed to be 80x24 cells). Further ncplanes can be created with
and new ncplanes are placed at the top of the z-buffer. Ncplanes can be larger, and new ncplanes are placed at the top of the z-buffer. Ncplanes can be larger,
smaller, or the same size as the physical screen, and can be placed anywhere smaller, or the same size as the physical screen, and can be placed anywhere
relative to it (including entirely off-screen). Ncplanes are made up of relative to it (including entirely off-screen). Ncplanes are made up of
`nccell`s (see [NcCells][] below). Information on ncplanes is available at **nccell**s (see [NcCells][] below). Information on ncplanes is available at
**notcurses_plane(3)**. **notcurses_plane(3)**.
## NcCells ## NcCells
`nccell`s make up the framebuffers backing each ncplane, one cell per **nccell**s make up the framebuffers backing each ncplane, one cell per
coordinate, one extended grapheme cluster (see **unicode(7)**) per cell. An coordinate, one extended grapheme cluster (see **unicode(7)**) per cell. An
`nccell` consists of a gcluster (either a directly-encoded 7-bit ASCII **nccell** consists of a gcluster (either a directly-encoded 7-bit ASCII
character (see **ascii(7)**), or a 25-bit index into the ncplane's egcpool), a character (see **ascii(7)**), or a 25-bit index into the ncplane's egcpool), a
set of attributes, and two channels (one for the foreground, and one for the set of attributes, and two channels (one for the foreground, and one for the
background—see **notcurses_channels(3)**). Information on cells is available at background—see **notcurses_channels(3)**). Information on cells is available at
**notcurses_cell(3)**. **notcurses_cell(3)**.
It is not usually necessary for users to interact directly with `nccell`s. They It is not usually necessary for users to interact directly with **nccell**s. They
are typically encountered when retrieving data from ncplanes or the rendered are typically encountered when retrieving data from ncplanes or the rendered
scene (see e.g. **ncplane_at_yx(3)**), or to achieve peak performance when a scene (see e.g. **ncplane_at_yx(3)**), or to achieve peak performance when a
particular EGC is heavily reused within a plane. particular EGC is heavily reused within a plane.

6
doc/man/man3/notcurses_channels.3.md
View File

@ -102,9 +102,9 @@ foreground channel and ***bchan*** as the background channel.
# RETURN VALUES # RETURN VALUES
Functions returning `int` return -1 on failure, or 0 on success. Failure is Functions returning **int** return -1 on failure, or 0 on success. Failure is
always due to invalid inputs. Functions returning `bool` are predicates, and always due to invalid inputs. Functions returning **bool** are predicates, and
return the requested value. Functions returning `unsigned` forms return the return the requested value. Functions returning **unsigned** forms return the
input, modified as requested. input, modified as requested.
**ncchannels_reverse** inverts the color components of the two channels, **ncchannels_reverse** inverts the color components of the two channels,