Direct Class Reference

#include <Direct.hh>

Inheritance diagram for Direct:

Collaboration diagram for Direct:

Public Member Functions
	Direct (const char *termtype=nullptr, FILE *fp=nullptr, uint64_t flags=0, NotCurses *ncinst=nullptr)
	~Direct ()
bool	clear () const NOEXCEPT_MAYBE
bool	set_fg_default () const NOEXCEPT_MAYBE
bool	set_fg_rgb (unsigned rgb) const NOEXCEPT_MAYBE
bool	set_fg_rgb (unsigned r, unsigned g, unsigned b) const NOEXCEPT_MAYBE
bool	fg_palindex (int pidx) const NOEXCEPT_MAYBE
bool	set_bg_default () const NOEXCEPT_MAYBE
bool	set_bg_rgb (unsigned rgb) const NOEXCEPT_MAYBE
bool	set_bg_rgb (unsigned r, unsigned g, unsigned b) const NOEXCEPT_MAYBE
bool	bg_palindex (int pidx) const NOEXCEPT_MAYBE
unsigned	get_dim_x () const NOEXCEPT_MAYBE
unsigned	get_dim_y () const NOEXCEPT_MAYBE
unsigned	get_palette_size () const noexcept
void	styles_set (CellStyle stylebits) const noexcept
void	styles_on (CellStyle stylebits) const noexcept
void	styles_off (CellStyle stylebits) const noexcept
bool	cursor_move_yx (int y, int x) const NOEXCEPT_MAYBE
bool	cursor_up (int num) const NOEXCEPT_MAYBE
bool	cursor_left (int num) const NOEXCEPT_MAYBE
bool	cursor_right (int num) const NOEXCEPT_MAYBE
bool	cursor_down (int num) const NOEXCEPT_MAYBE
bool	cursor_enable () const NOEXCEPT_MAYBE
bool	cursor_disable () const NOEXCEPT_MAYBE
void	get_cursor_yx (unsigned *y, unsigned *x) const noexcept
void	get_cursor_yx (unsigned &y, unsigned &x) const noexcept
int	render_image (const char *file, NCAlign align, ncblitter_e blitter, ncscale_e scale) const noexcept
ncdirectv *	prep_image (const char *file, ncblitter_e blitter, ncscale_e scale, int maxy, int maxx) const noexcept
int	raster_image (ncdirectv *faken, NCAlign align) const noexcept
int	streamfile (const char *filename, ncstreamcb streamer, struct ncvisual_options *vopts, void *curry) const NOEXCEPT_MAYBE
bool	putstr (uint64_t channels, const char *utf8) const NOEXCEPT_MAYBE
int	hline_interp (const char *egc, unsigned len, uint64_t h1, uint64_t h2) const noexcept
int	vline_interp (const char *egc, unsigned len, uint64_t h1, uint64_t h2) const noexcept
bool	box (uint64_t ul, uint64_t ur, uint64_t ll, uint64_t lr, const wchar_t *wchars, int ylen, int xlen, unsigned ctlword) const NOEXCEPT_MAYBE
bool	rounded_box (uint64_t ul, uint64_t ur, uint64_t ll, uint64_t lr, int ylen, int xlen, unsigned ctlword) const NOEXCEPT_MAYBE
bool	double_box (uint64_t ul, uint64_t ur, uint64_t ll, uint64_t lr, int ylen, int xlen, unsigned ctlword) const NOEXCEPT_MAYBE
bool	flush () const NOEXCEPT_MAYBE
char32_t	get (ncinput *ni, bool blocking) const noexcept
char32_t	get (const struct timespec *ts, ncinput *ni) const noexcept
int	get_inputready_fd () const noexcept
bool	canopen_images () const noexcept
bool	canutf8 () const noexcept
int	check_pixel_support () noexcept
Public Member Functions inherited from Root
notcurses *	get_notcurses () const
NotCurses *	get_notcurses_cpp () const

Additional Inherited Members
Protected Member Functions inherited from Root
	Root (NotCurses *ncinst)
bool	is_notcurses_stopped () const noexcept
Static Protected Member Functions inherited from Root
template<typename TRet = bool, typename TValue = int>
static TRet	error_guard (TValue ret, TValue error_value)
template<typename TRet = bool, typename TValue = int>
static TRet	error_guard_cond (TValue ret, bool error_value)
Static Protected Attributes inherited from Root
static constexpr char	ncpp_invalid_state_message [] = "notcurses++ is in an invalid state (already stopped?)"

Detailed Description

Definition at line 16 of file Direct.hh.

Constructor & Destructor Documentation

Direct()

Direct ( const char *  termtype = nullptr, FILE *  fp = nullptr, uint64_t  flags = 0, NotCurses *  ncinst = nullptr  )

inlineexplicit

Definition at line 19 of file Direct.hh.

            : Root (ncinst)
        {
            direct = ncdirect_init (termtype, fp == nullptr ? stdout : fp, flags);
            if (direct == nullptr)
                throw init_error ("Notcurses failed to initialize direct mode");
        }

Here is the call graph for this function:

~Direct()

~Direct ( )

inline

Definition at line 28 of file Direct.hh.

        {
            ncdirect_stop (direct);
        }

Here is the call graph for this function:

Member Function Documentation

bg_palindex()

bool bg_palindex ( int  pidx ) const

inline

Definition at line 73 of file Direct.hh.

        {
            return error_guard (ncdirect_set_bg_palindex (direct, pidx), -1);
        }

Here is the call graph for this function:

box()

bool box ( uint64_t  ul, uint64_t  ur, uint64_t  ll, uint64_t  lr, const wchar_t *  wchars, int  ylen, int  xlen, unsigned  ctlword  ) const

inline

Definition at line 190 of file Direct.hh.

        {
            return error_guard (ncdirect_box (direct, ul, ur, ll, lr, wchars, ylen, xlen, ctlword), -1);
        }

Here is the call graph for this function:

canopen_images()

bool canopen_images ( ) const

inlinenoexcept

Definition at line 227 of file Direct.hh.

        {
            return ncdirect_canopen_images (direct);
        }

canutf8()

bool canutf8 ( ) const

inlinenoexcept

Definition at line 232 of file Direct.hh.

        {
            return ncdirect_canutf8 (direct);
        }

Here is the call graph for this function:

check_pixel_support()

int check_pixel_support ( )

inlinenoexcept

Definition at line 237 of file Direct.hh.

        {
            return ncdirect_check_pixel_support (direct);
        }

Here is the call graph for this function:

clear()

bool clear ( ) const

inline

Definition at line 33 of file Direct.hh.

        {
            return error_guard (ncdirect_clear (direct), -1);
        }

Here is the call graph for this function:

cursor_disable()

bool cursor_disable ( ) const

inline

Definition at line 138 of file Direct.hh.

        {
            return error_guard (ncdirect_cursor_disable (direct), -1);
        }

Here is the call graph for this function:

cursor_down()

bool cursor_down ( int  num ) const

inline

Definition at line 128 of file Direct.hh.

        {
            return error_guard (ncdirect_cursor_down (direct, num), -1);
        }

Here is the call graph for this function:

cursor_enable()

bool cursor_enable ( ) const

inline

Definition at line 133 of file Direct.hh.

        {
            return error_guard (ncdirect_cursor_enable (direct), -1);
        }

Here is the call graph for this function:

cursor_left()

bool cursor_left ( int  num ) const

inline

Definition at line 118 of file Direct.hh.

        {
            return error_guard (ncdirect_cursor_left (direct, num), -1);
        }

Here is the call graph for this function:

cursor_move_yx()

bool cursor_move_yx ( int  y, int  x  ) const

inline

Definition at line 108 of file Direct.hh.

        {
            return error_guard (ncdirect_cursor_move_yx (direct, y, x), -1);
        }

Here is the call graph for this function:

cursor_right()

bool cursor_right ( int  num ) const

inline

Definition at line 123 of file Direct.hh.

        {
            return error_guard (ncdirect_cursor_right (direct, num), -1);
        }

Here is the call graph for this function:

cursor_up()

bool cursor_up ( int  num ) const

inline

Definition at line 113 of file Direct.hh.

        {
            return error_guard (ncdirect_cursor_up (direct, num), -1);
        }

Here is the call graph for this function:

double_box()

bool double_box ( uint64_t  ul, uint64_t  ur, uint64_t  ll, uint64_t  lr, int  ylen, int  xlen, unsigned  ctlword  ) const

inline

Definition at line 200 of file Direct.hh.

        {
            return error_guard (ncdirect_double_box (direct, ul, ur, ll, lr, ylen, xlen, ctlword), -1);
        }

Here is the call graph for this function:

fg_palindex()

bool fg_palindex ( int  pidx ) const

inline

Definition at line 53 of file Direct.hh.

        {
            return error_guard (ncdirect_set_fg_palindex (direct, pidx), -1);
        }

Here is the call graph for this function:

flush()

bool flush ( ) const

inline

Definition at line 205 of file Direct.hh.

        {
            return error_guard (ncdirect_flush (direct), -1);
        }

Here is the call graph for this function:

get() [1/2]

char32_t get ( const struct timespec *  ts, ncinput *  ni  ) const

inlinenoexcept

Definition at line 217 of file Direct.hh.

        {
            return ncdirect_get (direct, ts, ni);
        }

Here is the call graph for this function:

get() [2/2]

char32_t get ( ncinput *  ni, bool  blocking  ) const

inlinenoexcept

Definition at line 210 of file Direct.hh.

        {
            if (blocking)
                return ncdirect_get_blocking (direct, ni);
            return ncdirect_get_nblock (direct, ni);
        }

get_cursor_yx() [1/2]

void get_cursor_yx ( unsigned &  y, unsigned &  x  ) const

inlinenoexcept

Definition at line 148 of file Direct.hh.

        {
            get_cursor_yx (&y, &x);
        }

get_cursor_yx() [2/2]

void get_cursor_yx ( unsigned *  y, unsigned *  x  ) const

inlinenoexcept

Definition at line 143 of file Direct.hh.

        {
            ncdirect_cursor_yx (direct, y, x);
        }

Here is the call graph for this function:

get_dim_x()

unsigned get_dim_x ( ) const

inline

Definition at line 78 of file Direct.hh.

        {
            return ncdirect_dim_x (direct);
        }

Here is the call graph for this function:

get_dim_y()

unsigned get_dim_y ( ) const

inline

Definition at line 83 of file Direct.hh.

        {
            return ncdirect_dim_y (direct);
        }

Here is the call graph for this function:

get_inputready_fd()

int get_inputready_fd ( ) const

inlinenoexcept

Definition at line 222 of file Direct.hh.

        {
            return ncdirect_inputready_fd (direct);
        }

Here is the call graph for this function:

get_palette_size()

unsigned get_palette_size ( ) const

inlinenoexcept

Definition at line 88 of file Direct.hh.

        {
            return ncdirect_palette_size (direct);
        }

Here is the call graph for this function:

hline_interp()

int hline_interp ( const char *  egc, unsigned  len, uint64_t  h1, uint64_t  h2  ) const

inlinenoexcept

Definition at line 180 of file Direct.hh.

        {
            return ncdirect_hline_interp (direct, egc, len, h1, h2);
        }

Here is the call graph for this function:

prep_image()

ncdirectv * prep_image ( const char *  file, ncblitter_e  blitter, ncscale_e  scale, int  maxy, int  maxx  ) const

inlinenoexcept

Definition at line 158 of file Direct.hh.

        {
            return ncdirect_render_frame (direct, file, blitter, scale, maxy, maxx);
        }

Here is the call graph for this function:

putstr()

bool putstr ( uint64_t  channels, const char *  utf8  ) const

inline

Definition at line 173 of file Direct.hh.

        {
            return error_guard (ncdirect_putstr (direct, channels, utf8), -1);
        }

Here is the call graph for this function:

raster_image()

int raster_image ( ncdirectv *  faken, NCAlign  align  ) const

inlinenoexcept

Definition at line 163 of file Direct.hh.

        {
            return ncdirect_raster_frame (direct, faken, static_cast<ncalign_e>(align));
        }

Here is the call graph for this function:

render_image()

int render_image ( const char *  file, NCAlign  align, ncblitter_e  blitter, ncscale_e  scale  ) const

inlinenoexcept

Definition at line 153 of file Direct.hh.

        {
            return ncdirect_render_image (direct, file, static_cast<ncalign_e>(align), blitter, scale);
        }

Here is the call graph for this function:

rounded_box()

bool rounded_box ( uint64_t  ul, uint64_t  ur, uint64_t  ll, uint64_t  lr, int  ylen, int  xlen, unsigned  ctlword  ) const

inline

Definition at line 195 of file Direct.hh.

        {
            return error_guard (ncdirect_rounded_box (direct, ul, ur, ll, lr, ylen, xlen, ctlword), -1);
        }

Here is the call graph for this function:

set_bg_default()

bool set_bg_default ( ) const

inline

Definition at line 58 of file Direct.hh.

        {
            return error_guard (ncdirect_set_bg_default (direct), -1);
        }

Here is the call graph for this function:

set_bg_rgb() [1/2]

bool set_bg_rgb ( unsigned  r, unsigned  g, unsigned  b  ) const

inline

Definition at line 68 of file Direct.hh.

        {
            return error_guard (ncdirect_set_bg_rgb8 (direct, r, g, b), -1);
        }

set_bg_rgb() [2/2]

bool set_bg_rgb ( unsigned  rgb ) const

inline

Definition at line 63 of file Direct.hh.

        {
            return error_guard (ncdirect_set_bg_rgb (direct, rgb), -1);
        }

Here is the call graph for this function:

set_fg_default()

bool set_fg_default ( ) const

inline

Definition at line 38 of file Direct.hh.

        {
            return error_guard (ncdirect_set_fg_default (direct), -1);
        }

Here is the call graph for this function:

set_fg_rgb() [1/2]

bool set_fg_rgb ( unsigned  r, unsigned  g, unsigned  b  ) const

inline

Definition at line 48 of file Direct.hh.

        {
            return error_guard (ncdirect_set_fg_rgb8 (direct, r, g, b), -1);
        }

set_fg_rgb() [2/2]

bool set_fg_rgb ( unsigned  rgb ) const

inline

Definition at line 43 of file Direct.hh.

        {
            return error_guard (ncdirect_set_fg_rgb (direct, rgb), -1);
        }

Here is the call graph for this function:

streamfile()

int streamfile ( const char *  filename, ncstreamcb  streamer, struct ncvisual_options *  vopts, void *  curry  ) const

inline

Definition at line 168 of file Direct.hh.

        {
            return error_guard<int> (ncdirect_stream(direct, filename, streamer, vopts, curry), -1);
        }

Here is the call graph for this function:

styles_off()

void styles_off ( CellStyle  stylebits ) const

inlinenoexcept

Definition at line 103 of file Direct.hh.

        {
            ncdirect_off_styles (direct, static_cast<unsigned>(stylebits));
        }

Here is the call graph for this function:

styles_on()

void styles_on ( CellStyle  stylebits ) const

inlinenoexcept

Definition at line 98 of file Direct.hh.

        {
            ncdirect_on_styles (direct, static_cast<unsigned>(stylebits));
        }

Here is the call graph for this function:

styles_set()

void styles_set ( CellStyle  stylebits ) const

inlinenoexcept

Definition at line 93 of file Direct.hh.

        {
            ncdirect_set_styles (direct, static_cast<unsigned>(stylebits));
        }

Here is the call graph for this function:

vline_interp()

int vline_interp ( const char *  egc, unsigned  len, uint64_t  h1, uint64_t  h2  ) const

inlinenoexcept

Definition at line 185 of file Direct.hh.

        {
            return ncdirect_vline_interp (direct, egc, len, h1, h2);
        }

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• /home/dank/src/dankamongmen/notcurses/include/ncpp/Direct.hh