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

elaborate documentation for notcurses_refresh #1769

Browse Source
This commit is contained in:
nick black 2021-06-15 14:00:42 -04:00
parent d07071246b
commit 9ee120dfa2
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
USAGE.md
View File

@ -260,7 +260,8 @@ notcurses_term_dim_yx(const struct notcurses* n, int* restrict rows,
// Refresh the physical screen to match what was last rendered (i.e., without
// reflecting any changes since the last call to notcurses_render()). This is
// primarily useful if the screen is externally corrupted, or if an
// NCKEY_RESIZE event has been read and you're not ready to render.
// NCKEY_RESIZE event has been read and you're not yet ready to render. The
// current screen geometry is returned in 'y' and 'x', if they are not NULL.
int notcurses_refresh(struct notcurses* n, int* restrict y, int* restrict x);
// Enable or disable the terminal's cursor, if supported, placing it at

3
include/notcurses/notcurses.h
View File

@ -1075,7 +1075,8 @@ API int notcurses_linesigs_enable(struct notcurses* n);
// Refresh the physical screen to match what was last rendered (i.e., without
// reflecting any changes since the last call to notcurses_render()). This is
// primarily useful if the screen is externally corrupted, or if an
// NCKEY_RESIZE event has been read and you're not yet ready to render.
// NCKEY_RESIZE event has been read and you're not yet ready to render. The
// current screen geometry is returned in 'y' and 'x', if they are not NULL.
API int notcurses_refresh(struct notcurses* n, int* RESTRICT y, int* RESTRICT x);
// Extract the Notcurses context to which this plane is attached.