notcurses/doc/man/man3/notcurses_fade.3.md

38 lines
928 B
Markdown
Raw Normal View History

2020-01-13 21:29:53 +00:00
% notcurses_fade(3)
% nick black <nickblack@linux.com>
2020-01-29 06:03:00 +00:00
% v1.1.2
2020-01-13 21:29:53 +00:00
# NAME
notcurses_fade - fade ncplanes in and out
# SYNOPSIS
**#include <notcurses.h>**
```c
2020-01-17 14:30:53 +00:00
// Called for each delta performed in a fade on ncp. If anything but 0 is
// returned, the fading operation ceases immediately, and that value is
// propagated out. If provided and not NULL, the faders will not themselves
// call notcurses_render().
2020-01-13 21:29:53 +00:00
typedef int (*fadecb)(struct notcurses* nc, struct ncplane* ncp);
```
2020-01-17 14:30:53 +00:00
**bool notcurses_canfade(const struct notcurses* nc);**
2020-01-13 21:29:53 +00:00
2020-01-17 14:30:53 +00:00
**int ncplane_fadeout(struct ncplane* n, const struct timespec* ts, fadecb fader, void* curry);**
2020-01-13 21:29:53 +00:00
2020-01-17 14:30:53 +00:00
**int ncplane_fadein(struct ncplane* n, const struct timespec* ts, fadecb fader, void* curry);**
**int ncplane_pulse(struct ncplane* n, const struct timespec* ts, fadecb fader, void* curry);**
2020-01-13 21:29:53 +00:00
# DESCRIPTION
# RETURN VALUES
# BUGS
# SEE ALSO
**notcurses(3)**, **notcurses_ncplane(3)**