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] fix ncplane_[format|stain] docs

Browse Source
This commit is contained in:
joseLuís 2021-11-12 19:56:13 +01:00
parent 8491b6f64b
commit da13d8938d
2 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
USAGE.md
View File

@ -1628,9 +1628,9 @@ int ncplane_gradient2x1(struct ncplane* n, int y, int x, unsigned ylen,
uint32_t ll, uint32_t lr); uint32_t ll, uint32_t lr);
// Set the given style throughout the specified region, keeping content and // Set the given style throughout the specified region, keeping content and
// channels unchanged. The upper left corner is at 'x', 'y', and -1 may be // channels unchanged. The upper left corner is at 'y', 'x', and -1 may be
// specified to indicate the cursor's position in that dimension. The area // specified to indicate the cursor's position in that dimension. The area
// is specified by 'xlen', 'ylen', and 0 may be specified to indicate everything // is specified by 'ylen', 'xlen', and 0 may be specified to indicate everything
// remaining to the right and below, respectively. It is an error for any // remaining to the right and below, respectively. It is an error for any
// coordinate to be outside the plane. Returns the number of cells set, // coordinate to be outside the plane. Returns the number of cells set,
// or -1 on failure. // or -1 on failure.
@ -1638,9 +1638,9 @@ int ncplane_format(struct ncplane* n, int y, int x, unsigned ylen,
unsigned xlen, uint16_t stylemask); unsigned xlen, uint16_t stylemask);
// Set the given channels throughout the specified region, keeping content and // Set the given channels throughout the specified region, keeping content and
// channels unchanged. The upper left corner is at 'x', 'y', and -1 may be // channels unchanged. The upper left corner is at 'y', 'x', and -1 may be
// specified to indicate the cursor's position in that dimension. The area // specified to indicate the cursor's position in that dimension. The area
// is specified by 'xlen', 'ylen', and 0 may be specified to indicate everything // is specified by 'ylen', 'xlen', and 0 may be specified to indicate everything
// remaining to the right and below, respectively. It is an error for any // remaining to the right and below, respectively. It is an error for any
// coordinate to be outside the plane. Returns the number of cells set, // coordinate to be outside the plane. Returns the number of cells set,
// or -1 on failure. // or -1 on failure.

20
include/notcurses/notcurses.h
View File

@ -2406,22 +2406,24 @@ API int ncplane_gradient2x1(struct ncplane* n, int y, int x, unsigned ylen,
// Set the given style throughout the specified region, keeping content and // Set the given style throughout the specified region, keeping content and
// channels unchanged. The upper left corner is at 'y', 'x', and -1 may be // channels unchanged. The upper left corner is at 'y', 'x', and -1 may be
// specified to indicate the cursor's position in that dimension. The lower // specified to indicate the cursor's position in that dimension. The area
// right corner is specified by 'ystop', 'xstop'. It is an error for any // is specified by 'ylen', 'xlen', and 0 may be specified to indicate everything
// remaining to the right and below, respectively. It is an error for any
// coordinate to be outside the plane. Returns the number of cells set, // coordinate to be outside the plane. Returns the number of cells set,
// or -1 on failure. // or -1 on failure.
API int ncplane_format(struct ncplane* n, int y, int x, unsigned ystop, API int ncplane_format(struct ncplane* n, int y, int x, unsigned ylen,
unsigned xstop, uint16_t stylemask) unsigned xlen, uint16_t stylemask)
__attribute__ ((nonnull (1))); __attribute__ ((nonnull (1)));
// Set the given channels throughout the specified region, keeping content and // Set the given channels throughout the specified region, keeping content and
// attributes unchanged. The upper left corner is at 'x', 'y', and -1 may be // channels unchanged. The upper left corner is at 'y', 'x', and -1 may be
// specified to indicate the cursor's position in that dimension. The lower // specified to indicate the cursor's position in that dimension. The area
// right corner is specified by 'xstop', 'ystop'. It is an error for any // is specified by 'ylen', 'xlen', and 0 may be specified to indicate everything
// remaining to the right and below, respectively. It is an error for any
// coordinate to be outside the plane. Returns the number of cells set, // coordinate to be outside the plane. Returns the number of cells set,
// or -1 on failure. // or -1 on failure.
API int ncplane_stain(struct ncplane* n, int y, int x, unsigned ystop, API int ncplane_stain(struct ncplane* n, int y, int x, unsigned ylen,
unsigned xstop, uint64_t ul, uint64_t ur, unsigned xlen, uint64_t ul, uint64_t ur,
uint64_t ll, uint64_t lr) uint64_t ll, uint64_t lr)
__attribute__ ((nonnull (1))); __attribute__ ((nonnull (1)));