notcurses/doc/man/man3/notcurses_ncvisual.3.md
Nick Black f6975d11d5
Docs/API sweep for 1.0.0 #244 #249 (#250)
* sync up some docs #244
* sync README and man page
* notcurses_output() man page work
* pull attr/channels from output functions #244
* witherworm: clean up explicit moves #244
* still more man page work
* notcurses_lines, last of the man pages i think
* panelreel man page #244
* debian: ruby-ronn->pandoc
* debian: full multiarch compliance
* debian: symbols file
* pandoc: fix syntax for lexgrog
* fm6.mkv: strip audio
* pandoc: fix up apropos man syntax #249
* ncurses_lines man page
2020-01-04 02:37:55 -05:00

1.3 KiB

% notcurses_ncvisual(3) % nick black nickblack@linux.com % v1.0.0

NAME

notcurses_ncvisual - notcurses multimedia

SYNOPSIS

#include <notcurses.h>

struct ncvisual ncplane_visual_open(struct ncplane nc, const char* file, int* averr);**

typedef enum {
  NCSCALE_NONE,
  NCSCALE_SCALE,
  NCSCALE_STRETCH,
} ncscale_e;

struct ncvisual ncvisual_open_plane(struct notcurses nc, const char* file, int* averr, int y, int x, ncscale_e style);**

void ncvisual_destroy(struct ncvisual ncv);*

struct AVFrame ncvisual_decode(struct ncvisual nc, int* averr);**

int ncvisual_render(const struct ncvisual ncv, int begy, int begx, int leny, int lenx);*

typedef int (streamcb)(struct notcurses, struct ncvisual, void);**

int ncvisual_simple_streamer(struct notcurses nc, struct ncvisual ncv, void* curry);**

int ncvisual_stream(struct notcurses nc, struct ncvisual ncv, int* averr, streamcb streamer, void* curry);**

struct ncplane ncvisual_plane(struct ncvisual ncv);**

DESCRIPTION

RETURN VALUES

SEE ALSO

notcurses(3), notcurses_ncplane(3)