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

update notcurses_plane.3 and USAGE.md for new styles API

Browse Source
This commit is contained in:
nick black 2020-09-29 13:03:09 -04:00 committed by Nick Black
parent 683217ef07
commit afa65f640f
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
USAGE.md
View File

@ -778,15 +778,17 @@ not rendered. Note that the base cell, like every other cell, has its own
foreground and background channels. foreground and background channels.
```c ```c
uint16_t ncplane_styles(const struct ncplane* n);**
// Set the specified style bits for the ncplane 'n', whether they're actively // Set the specified style bits for the ncplane 'n', whether they're actively
// supported or not. // supported or not.
void ncplane_styles_set(struct ncplane* n, unsigned stylebits); void ncplane_set_styles(struct ncplane* n, unsigned stylebits);
// Add the specified styles to the ncplane's existing spec. // Add the specified styles to the ncplane's existing spec.
void ncplane_styles_on(struct ncplane* n, unsigned stylebits); void ncplane_on_styles(struct ncplane* n, unsigned stylebits);
// Remove the specified styles from the ncplane's existing spec. // Remove the specified styles from the ncplane's existing spec.
void ncplane_styles_off(struct ncplane* n, unsigned stylebits); void ncplane_off_styles(struct ncplane* n, unsigned stylebits);
// Set the ncplane's base cell to this cell. It will be used for purposes of // Set the ncplane's base cell to this cell. It will be used for purposes of
// rendering anywhere that the ncplane's gcluster is 0. Erasing the ncplane // rendering anywhere that the ncplane's gcluster is 0. Erasing the ncplane

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

@ -100,12 +100,8 @@ typedef struct ncplane_options {
**uint64_t ncplane_channels(const struct ncplane* n);** **uint64_t ncplane_channels(const struct ncplane* n);**
**uint16_t ncplane_attr(const struct ncplane* n);**
**void ncplane_set_channels(struct ncplane* nc, uint64_t channels);** **void ncplane_set_channels(struct ncplane* nc, uint64_t channels);**
**void ncplane_set_attr(struct ncplane* nc, uint32_t styles);**
**static inline unsigned ncplane_bchannel(struct ncplane* nc);** **static inline unsigned ncplane_bchannel(struct ncplane* nc);**
**static inline unsigned ncplane_fchannel(struct ncplane* nc);** **static inline unsigned ncplane_fchannel(struct ncplane* nc);**
@ -146,11 +142,13 @@ typedef struct ncplane_options {
**int ncplane_set_bg_palindex(struct ncplane* n, int idx);** **int ncplane_set_bg_palindex(struct ncplane* n, int idx);**
**void ncplane_styles_set(struct ncplane* n, unsigned stylebits);** **uint16_t ncplane_styles(const struct ncplane* n);**
**void ncplane_styles_on(struct ncplane* n, unsigned stylebits);** **void ncplane_set_styles(struct ncplane* n, unsigned stylebits);**
**void ncplane_styles_off(struct ncplane* n, unsigned stylebits);** **void ncplane_on_styles(struct ncplane* n, unsigned stylebits);**
**void ncplane_off_styles(struct ncplane* n, unsigned stylebits);**
**void ncplane_greyscale(struct ncplane* n);** **void ncplane_greyscale(struct ncplane* n);**