Archives
/
notcurses
mirror of https://github.com/dankamongmen/notcurses
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

argument syntax for man pages: cell, channels #1103

Browse Source
dankamongmen/clock_nanosleep_portable
nick black 4 years ago
parent 7018f2589f
commit cf75598f03
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
2 changed files with 68 additions and 70 deletions
Show Stats Download Patch File Download Diff File

76
doc/man/man3/notcurses_cell.3.md
Unescape Escape View File

@ -41,80 +41,80 @@ typedef struct cell {
#define CELL_ALPHA_OPAQUE 0x00000000ull
```
**void cell_init(cell* c);**
**void cell_init(cell* ***c***);**
**int cell_load(struct ncplane* n, cell* c, const char* gcluster);**
**int cell_load(struct ncplane* ***n***, cell* ***c***, const char* ***gcluster***);**
**int cell_prime(struct ncplane* n, cell* c, const char* gcluster,
uint32_t stylemask, uint64_t channels);**
**int cell_prime(struct ncplane* ***n***, cell* ***c***, const char* ***gcluster***,
uint32_t ***stylemask***, uint64_t ***channels***);**
**int cell_duplicate(struct ncplane* n, cell* targ, const cell* c);**
**int cell_duplicate(struct ncplane* ***n***, cell* ***targ***, const cell* ***c***);**
**void cell_release(struct ncplane* n, cell* c);**
**void cell_release(struct ncplane* ***n***, cell* ***c***);**
**void cell_styles_set(cell* c, unsigned stylebits);**
**void cell_styles_set(cell* ***c***, unsigned ***stylebits***);**
**unsigned cell_styles(const cell* c);**
**unsigned cell_styles(const cell* ***c***);**
**void cell_styles_on(cell* c, unsigned stylebits);**
**void cell_styles_on(cell* ***c***, unsigned ***stylebits***);**
**void cell_styles_off(cell* c, unsigned stylebits);**
**void cell_styles_off(cell* ***c***, unsigned ***stylebits***);**
**void cell_set_fg_default(cell* c);**
**void cell_set_fg_default(cell* ***c***);**
**void cell_set_bg_default(cell* c);**
**void cell_set_bg_default(cell* ***c***);**
**int cell_set_fg_alpha(cell* c, unsigned alpha);**
**int cell_set_fg_alpha(cell* ***c***, unsigned ***alpha***);**
**int cell_set_bg_alpha(cell* c, unsigned alpha);**
**int cell_set_bg_alpha(cell* ***c***, unsigned ***alpha***);**
**bool cell_double_wide_p(const cell* c);**
**bool cell_double_wide_p(const cell* ***c***);**
**const char* cell_extended_gcluster(const struct ncplane* n, const cell* c);**
**const char* cell_extended_gcluster(const struct ncplane* ***n***, const cell* ***c***);**
**char* cell_strdup(const struct ncplane* n, const cell* c);**
**char* cell_strdup(const struct ncplane* ***n***, const cell* ***c***);**
**int cell_load_simple(struct ncplane* n, cell* c, char ch);**
**int cell_load_simple(struct ncplane* ***n***, cell* ***c***, char ***ch***);**
**char* cell_extract(const struct ncplane* n, const cell* c, uint16_t* stylemask, uint64_t* channels);**
**char* cell_extract(const struct ncplane* ***n***, const cell* ***c***, uint16_t* ***stylemask***, uint64_t* ***channels***);**
**uint32_t cell_bchannel(const cell* cl);**
**uint32_t cell_bchannel(const cell* ***c***);**
**uint32_t cell_fchannel(const cell* cl);**
**uint32_t cell_fchannel(const cell* ***c***);**
**uint64_t cell_set_bchannel(cell* cl, uint32_t channel);**
**uint64_t cell_set_bchannel(cell* ***c***, uint32_t ***channel***);**
**uint64_t cell_set_fchannel(cell* cl, uint32_t channel);**
**uint64_t cell_set_fchannel(cell* ***c***, uint32_t ***channel***);**
**uint32_t cell_fg_rgb(const cell* cl);**
**uint32_t cell_fg_rgb(const cell* ***c***);**
**uint32_t cell_bg_rgb(const cell* cl);**
**uint32_t cell_bg_rgb(const cell* ***c***);**
**unsigned cell_fg_alpha(const cell* cl);**
**unsigned cell_fg_alpha(const cell* ***c***);**
**unsigned cell_bg_alpha(const cell* cl);**
**unsigned cell_bg_alpha(const cell* ***c***);**
**unsigned cell_fg_rgb8(const cell* cl, unsigned* r, unsigned* g, unsigned* b);**
**unsigned cell_fg_rgb8(const cell* ***c***, unsigned* ***r***, unsigned* ***g***, unsigned* ***b***);**
**unsigned cell_bg_rgb8(const cell* cl, unsigned* r, unsigned* g, unsigned* b);**
**unsigned cell_bg_rgb8(const cell* ***c***, unsigned* ***r***, unsigned* ***g***, unsigned* ***b***);**
**int cell_set_fg_rgb8(cell* cl, int r, int g, int b);**
**int cell_set_fg_rgb8(cell* ***c***, int ***r***, int ***g***, int ***b***);**
**int cell_set_bg_rgb8(cell* cl, int r, int g, int b);**
**int cell_set_bg_rgb8(cell* ***c***, int ***r***, int ***g***, int ***b***);**
**void cell_set_fg_rgb8_clipped(cell* cl, int r, int g, int b);**
**void cell_set_fg_rgb8_clipped(cell* ***c***, int ***r***, int ***g***, int ***b***);**
**void cell_set_bg_rgb8_clipped(cell* cl, int r, int g, int b);**
**void cell_set_bg_rgb8_clipped(cell* ***c***, int ***r***, int ***g***, int ***b***);**
**int cell_set_fg_rgb(cell* c, uint32_t channel);**
**int cell_set_fg_rgb(cell* ***c***, uint32_t ***channel***);**
**int cell_set_bg_rgb(cell* c, uint32_t channel);**
**int cell_set_bg_rgb(cell* ***c***, uint32_t ***channel***);**
**bool cell_fg_default_p(const cell* cl);**
**bool cell_fg_default_p(const cell* ***c***);**
**bool cell_bg_default_p(const cell* cl);**
**bool cell_bg_default_p(const cell* ***c***);**
**int ncstrwidth(const char* text)**;
**int ncstrwidth(const char* ***text***)**;
# DESCRIPTION

62
doc/man/man3/notcurses_channels.3.md
Unescape Escape View File

@ -19,67 +19,65 @@ notcurses_channels - operations on notcurses channels
(((uint32_t)r << 16u) + ((uint32_t)g << 8u) + (b) + CELL_BGDEFAULT_MASK)
```
**unsigned channel_r(unsigned channel);**
**uint32_t channel_r(uint32_t ***channel***);**
**unsigned channel_g(unsigned channel);**
**uint32_t channel_g(uint32_t ***channel***);**
**unsigned channel_b(unsigned channel);**
**uint32_t channel_b(uint32_t ***channel***);**
**unsigned channel_rgb8(unsigned channel, unsigned* restrict r, unsigned* restrict g, unsigned* restrict b);**
**uint32_t channel_rgb8(uint32_t channel, uint32_t* restrict ***r***, uint32_t* restrict ***g***, uint32_t* restrict ***b***);**
**int channel_set_rgb8(unsigned* channel, int r, int g, int b);**
**int channel_set_rgb8(uint32_t* channel, int ***r***, int ***g***, int ***b***);**
**int channel_set(unsigned* channel, unsigned rgb);**
**int channel_set(uint32_t* channel, uint32_t rg***b***);**
**unsigned channel_alpha(unsigned channel);**
**uint32_t channel_alpha(uint32_t ***channel***);**
**int channel_set_alpha(unsigned* channel, int alpha);**
**int channel_set_alpha(uint32_t* ***channel***, unsigned ***alpha***);**
**bool channel_default_p(unsigned channel);**
**bool channel_default_p(uint32_t ***channel***);**
**unsigned channel_set_default(unsigned* channel);**
**uint32_t channel_set_default(uint32_t* ***channel***);**
**unsigned channels_bchannel(uint64_t channels);**
**unsigned channels_bchannel(uint64_t ***channels***);**
**unsigned channels_fchannel(uint64_t channels);**
**unsigned channels_fchannel(uint64_t ***channels***);**
**uint64_t channels_set_bchannel(uint64_t* channels, uint32_t channel);**
**uint64_t channels_set_bchannel(uint64_t* ***channels***, uint32_t ***channel***);**
**uint64_t channels_set_fchannel(uint64_t* channels, uint32_t channel);**
**uint64_t channels_set_fchannel(uint64_t* ***channels***, uint32_t ***channel***);**
**unsigned channels_fg_rgb(uint64_t channels);**
**unsigned channels_fg_rgb(uint64_t ***channels***);**
**unsigned channels_bg_rgb(uint64_t channels);**
**unsigned channels_bg_rgb(uint64_t ***channels***);**
**unsigned channels_fg_alpha(uint64_t channels);**
**unsigned channels_fg_alpha(uint64_t ***channels***);**
**unsigned channels_bg_alpha(uint64_t channels);**
**unsigned channels_bg_alpha(uint64_t ***channels***);**
**unsigned channels_fg_rgb8(uint64_t channels, unsigned* r, unsigned* g, unsigned* b);**
**unsigned channels_fg_rgb8(uint64_t ***channels***, unsigned* ***r***, unsigned* ***g***, unsigned* ***b***);**
**unsigned channels_bg_rgb8(uint64_t channels, unsigned* r, unsigned* g, unsigned* b);**
**unsigned channels_bg_rgb8(uint64_t ***channels***, unsigned* ***r***, unsigned* ***g***, unsigned* ***b***);**
**int channels_set_fg_rgb8(uint64_t* channels, int r, int g, int b);**
**int channels_set_fg_rgb8(uint64_t* ***channels***, int ***r***, int ***g***, int ***b***);**
**int channels_set_bg_rgb8(uint64_t* channels, int r, int g, int b);**
**int channels_set_bg_rgb8(uint64_t* ***channels***, int ***r***, int ***g***, int ***b***);**
**int channels_set_fg_rgb(uint64_t* channels, unsigned rgb);**
**int channels_set_fg_rgb(uint64_t* ***channels***, unsigned ***rgb***);**
**int channels_set_bg_rgb(uint64_t* channels, unsigned rgb);**
**int channels_set_bg_rgb(uint64_t* ***channels***, unsigned ***rgb***);**
**int channels_set_fg_alpha(uint64_t* channels, int alpha);**
**int channels_set_fg_alpha(uint64_t* ***channels***, int ***alpha***);**
**int channels_set_bg_alpha(uint64_t* channels, int alpha);**
**int channels_set_bg_alpha(uint64_t* ***channels***, int ***alpha***);**
**bool channels_fg_default_p(uint64_t channels);**
**bool channels_fg_default_p(uint64_t ***channels***);**
**bool channels_bg_default_p(uint64_t channels);**
**bool channels_bg_default_p(uint64_t ***channels***);**
**uint64_t channels_set_fg_default(uint64_t* channels);**
**uint64_t channels_set_fg_default(uint64_t* ***channels***);**
**uint64_t channels_set_bg_default(uint64_t* channels);**
**unsigned channels_blend(unsigned c1, unsigned c2, unsigned blends);**
**uint64_t channels_set_bg_default(uint64_t* ***channels***);**
# DESCRIPTION

Write Preview
Loading…
Cancel
Save