Archives/notcurses
2
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses.git synced 2024-10-31 15:20:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

visual.3: add ncvisual_subtitle() to man page

Browse Source
This commit is contained in:
nick black 2020-05-04 00:56:52 -04:00 committed by Nick Black
parent ecdc85de11
commit 2ec3a8a5ca
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/man/man3/notcurses_visual.3.md
View File

@ -46,6 +46,7 @@ typedef int (*streamcb)(struct notcurses*, struct ncvisual*, void*);
**int ncplane_rotate_ccw(struct ncplane* n);**
**char* ncvisual_subtitle(const struct ncvisual* ncv);**
# DESCRIPTION
@ -62,6 +63,10 @@ result in a zero-area rendering.
Both **ncplane_rotate_cw** and **ncplane_rotate_ccw** execute a rotation of
π/2 radians, in the clockwise or counterclockwise direction respectively.
**ncvisual_subtitle** will return a UTF-8-encoded subtitle corresponding to
the current frame if such a subtitle was decoded. Note that a subtitle might
be returned for multiple frames, or might not.
# RETURN VALUES
**notcurses_canopen** returns true if this functionality is enabled, or false
@ -79,8 +84,10 @@ the number of cells emitted, or -1 on error.
Multimedia decoding requires that Notcurses be built with either FFmpeg or
OpenImageIO support. What formats can be decoded is totally dependent on the
linked library.
linked library. OpenImageIO does not support subtitles.
# SEE ALSO
**notcurses(3)**, **notcurses_ncplane(3)**
**notcurses(3)**,
**notcurses_ncplane(3)**,
**utf-8(7)**