notcurses/include/ncpp/Visual.hh
Marek Habersack 943e23535f [C++] API sync
Fixes: https://github.com/dankamongmen/notcurses/issues/1025

Added:
  * Direct: flush (`ncdirect_flush`)
  * Direct: getc (`ncdirect_getc_blocking` and `ncdirect_getc_nblock`)
  * Direct: getc (`ncdirect_getc`)
  * Direct: get_inputready_fd (`ncdirect_inputready_fd`)
  * NotCurses: align (`notcurses_align`)
  * NotCurses: ucs32_to_utf8 (`notcurses_ucs32_to_utf8`)
  * NotCurses: get_bottom (`notcurses_bottom`)
  * Plane: resize_realign (`ncplane_resize_realign`)
  * Plane: get_x (`ncplane_x`)
  * Plane: get_y (`ncplane_y`)
  * Plane: mergedown (`ncplane_mergedown`)
  * Plane: putwc_stained (`ncplane_putwc_stained`)
  * Plane: putstr_stained (`ncplane_putstr_stained`)
  * Plane: set_fchannel (`ncplane_set_fchannel`)
  * Plane: set_bchannel (`ncplane_set_bchannel`)
  * Plane: get_styles (`ncplane_styles`)
  * Plane: get_above (`ncplane_above`)
  * Reader: move_left (`ncreader_move_left`)
  * Reader: move_right (`ncreader_move_right`)
  * Reader: move_up (`ncreader_move_up`)
  * Reader: move_down (`ncreader_move_down`)
  * Reader: write_egc (`ncreader_write_egc`)
  * Visual: get_default_blitter (`ncvisual_default_blitter`)

Fixed:
  * NotCurses: `cursor_{enable,disable}` must use `NOEXCEPT_MAYBE`
  * Plane: renamed `putcw` to `putwc`
2020-09-27 15:32:25 -04:00

133 lines
3.3 KiB
C++

#ifndef __NCPP_VISUAL_HH
#define __NCPP_VISUAL_HH
#include <notcurses/notcurses.h>
#include "Root.hh"
#include "Plane.hh"
#include "Utilities.hh"
#include "NotCurses.hh"
namespace ncpp
{
class NotCurses;
class Plane;
class NCPP_API_EXPORT Visual : public Root
{
public:
explicit Visual (const char *file)
: Root (NotCurses::get_instance ())
{
visual = ncvisual_from_file (file);
if (visual == nullptr)
throw init_error ("Notcurses failed to create a new visual");
}
explicit Visual (const uint32_t* rgba, int rows, int rowstride, int cols)
: Root (NotCurses::get_instance ())
{
visual = ncvisual_from_rgba (rgba, rows, rowstride, cols);
if (visual == nullptr)
throw init_error ("Notcurses failed to create a new visual");
}
explicit Visual (const Plane& p, ncblitter_e blit, int begy, int begx, int leny, int lenx)
: Root (NotCurses::get_instance ())
{
visual = ncvisual_from_plane (p, blit, begy, begx, leny, lenx);
if (visual == nullptr)
throw init_error ("Notcurses failed to create a new visual");
}
~Visual () noexcept
{
if (!is_notcurses_stopped ())
ncvisual_destroy (visual);
}
operator ncvisual* () const noexcept
{
return visual;
}
operator ncvisual const* () const noexcept
{
return visual;
}
int decode () const noexcept
{
return ncvisual_decode (visual);
}
ncplane* render (const ncvisual_options* vopts) const NOEXCEPT_MAYBE
{
return error_guard<ncplane*, ncplane*> (ncvisual_render (get_notcurses (), visual, vopts), nullptr);
}
int stream (const ncvisual_options* vopts, float timescale, streamcb streamer, void *curry = nullptr) const NOEXCEPT_MAYBE
{
return error_guard<int> (ncvisual_stream (get_notcurses (), visual, timescale, streamer, vopts, curry), -1);
}
char* subtitle () const noexcept
{
return ncvisual_subtitle (visual);
}
bool rotate (double rads) const NOEXCEPT_MAYBE
{
return error_guard (ncvisual_rotate (visual, rads), -1);
}
bool simple_streamer (ncvisual_options* vopts, const timespec* tspec, void* curry = nullptr) const NOEXCEPT_MAYBE
{
return error_guard (ncvisual_simple_streamer (visual, vopts, tspec, curry), -1);
}
int polyfill (int y, int x, uint32_t rgba) const NOEXCEPT_MAYBE
{
return error_guard<int> (ncvisual_polyfill_yx (visual, y, x, rgba), -1);
}
bool geom (const struct ncvisual_options *vopts, int *y, int *x, int *toy, int *tox) const NOEXCEPT_MAYBE
{
return error_guard (ncvisual_geom (get_notcurses (), visual, vopts, y, x, toy, tox), -1);
}
bool at (int y, int x, uint32_t* pixel) const
{
if (pixel == nullptr)
throw invalid_argument ("'pixel' must be a valid pointer");
return error_guard (ncvisual_at_yx (visual, y, x, pixel), -1);
}
bool set (int y, int x, uint32_t pixel) const NOEXCEPT_MAYBE
{
return error_guard (ncvisual_set_yx (visual, y, x, pixel), -1);
}
static ncblitter_e get_default_blitter (bool utf8, ncscale_e scale) noexcept
{
return ncvisual_default_blitter (utf8, scale);
}
private:
void common_init (ncplane *plane, const char *file)
{
if (plane == nullptr)
throw invalid_argument ("'plane' must be a valid pointer");
visual = ncvisual_from_file (file);
if (visual == nullptr)
throw init_error ("Notcurses failed to create a new visual");
}
private:
ncvisual *visual = nullptr;
};
}
#endif