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

[docs] correct definition of ncprogbar_options #2639

Browse Source
This commit is contained in:
nick black 2022-03-31 03:18:55 -04:00 committed by nick black
parent 2e112ffb22
commit b292bba6df
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
USAGE.md
View File

@ -2830,10 +2830,10 @@ struct ncprogbar* ncprogbar_create(struct ncplane* n, const ncprogbar_options* o
#define NCPROGBAR_OPTION_RETROGRADE 0x0001u // proceed left/down
typedef struct ncprogbar_options {
// channels for the maximum and minimum points. linear interpolation will be
// applied across the domain between these two.
uint64_t maxchannels;
uint64_t minchannels;
uint32_t ulchannel; // upper-left channel. in the context of a progress bar,
uint32_t urchannel; // "up" is the direction we are progressing towards, and
uint32_t blchannel; // "bottom" is the direction of origin. for monochromatic
uint32_t brchannel; // bar, all four channels ought be the same.
uint64_t flags;
} ncprogbar_options;

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

@ -16,8 +16,10 @@ struct ncprogbar;
#define NCPROGBAR_OPTION_RETROGRADE 0x0001u // proceed left/down
typedef struct ncprogbar_options {
uint64_t maxchannels;
uint64_t minchannels;
uint32_t ulchannel; // upper-left channel. in the context of a progress bar,
uint32_t urchannel; // "up" is the direction we are progressing towards, and
uint32_t blchannel; // "bottom" is the direction of origin. for monochromatic
uint32_t brchannel; // bar, all four channels ought be the same.
uint64_t flags;
} ncprogbar_options;
```