mirror of
https://github.com/dankamongmen/notcurses.git
synced 2024-11-02 09:40:15 +00:00
explain the return value of ncplane_set_base
This commit is contained in:
parent
0ea7c5236d
commit
8432486b26
@ -1384,6 +1384,7 @@ API int ncplane_set_base_cell(struct ncplane* n, const nccell* c);
|
||||
// Set the ncplane's base nccell. It will be used for purposes of rendering
|
||||
// anywhere that the ncplane's gcluster is 0. Note that the base cell is not
|
||||
// affected by ncplane_erase(). 'egc' must be an extended grapheme cluster.
|
||||
// Returns the number of bytes copied out of 'gcluster', or -1 on failure.
|
||||
API int ncplane_set_base(struct ncplane* n, const char* egc,
|
||||
uint32_t stylemask, uint64_t channels);
|
||||
|
||||
|
@ -634,6 +634,8 @@ impl NcPlane {
|
||||
|
||||
/// Sets this NcPlane's base [NcCell] from its components.
|
||||
///
|
||||
/// Returns the number of bytes copied out of `egc` if succesful.
|
||||
///
|
||||
/// It will be used for purposes of rendering anywhere that the NcPlane's
|
||||
/// gcluster is 0.
|
||||
///
|
||||
|
Loading…
Reference in New Issue
Block a user