Visual Class Reference

#include <Visual.hh>

Inheritance diagram for Visual:

Collaboration diagram for Visual:

Public Member Functions
	Visual (const char *file)
	Visual (const uint32_t *rgba, int rows, int rowstride, int cols)
	Visual (const Plane &p, ncblitter_e blit, unsigned begy, unsigned begx, unsigned leny, unsigned lenx)
	~Visual () noexcept
	operator ncvisual * () const noexcept
	operator ncvisual const * () const noexcept
int	decode () const noexcept
int	decode_loop () const noexcept
ncplane *	blit (const ncvisual_options *vopts) const NOEXCEPT_MAYBE
int	stream (const ncvisual_options *vopts, float timescale, ncstreamcb streamer, void *curry=nullptr) const NOEXCEPT_MAYBE
ncplane *	subtitle (Plane &parent) noexcept
bool	rotate (double rads) const NOEXCEPT_MAYBE
bool	simple_streamer (ncvisual_options *vopts, const timespec *tspec, void *curry=nullptr) const NOEXCEPT_MAYBE
int	polyfill (int y, int x, uint32_t rgba) const NOEXCEPT_MAYBE
bool	geom (const struct ncvisual_options *vopts, ncvgeom *geom) const NOEXCEPT_MAYBE
bool	at (int y, int x, uint32_t *pixel) const
bool	set (int y, int x, uint32_t pixel) const NOEXCEPT_MAYBE
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 Visual.hh.

Constructor & Destructor Documentation

Visual() [1/3]

Visual ( const char *  file )

inlineexplicit

Definition at line 19 of file Visual.hh.

            : Root (NotCurses::get_instance ())
        {
            visual = ncvisual_from_file (file);
            if (visual == nullptr)
                throw init_error ("Notcurses failed to create a new visual");
        }

Here is the call graph for this function:

Visual() [2/3]

Visual ( const uint32_t *  rgba, int  rows, int  rowstride, int  cols  )

inlineexplicit

Definition at line 27 of file Visual.hh.

            : 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");
        }

Here is the call graph for this function:

Visual() [3/3]

Visual ( const Plane &  p, ncblitter_e  blit, unsigned  begy, unsigned  begx, unsigned  leny, unsigned  lenx  )

inlineexplicit

Definition at line 35 of file Visual.hh.

            : 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");
        }

Here is the call graph for this function:

~Visual()

~Visual ( )

inlinenoexcept

Definition at line 43 of file Visual.hh.

        {
            if (!is_notcurses_stopped ())
                ncvisual_destroy (visual);
        }

Here is the call graph for this function:

Member Function Documentation

at()

bool at ( int  y, int  x, uint32_t *  pixel  ) const

inline

Definition at line 104 of file Visual.hh.

        {
            if (pixel == nullptr)
                throw invalid_argument ("'pixel' must be a valid pointer");
 
            return error_guard (ncvisual_at_yx (visual, y, x, pixel), -1);
        }

Here is the call graph for this function:

blit()

ncplane * blit ( const ncvisual_options *  vopts ) const

inline

Definition at line 69 of file Visual.hh.

        {
            return error_guard<ncplane*, ncplane*> (ncvisual_blit (get_notcurses (), visual, vopts), nullptr);
        }

Here is the call graph for this function:

decode()

int decode ( ) const

inlinenoexcept

Definition at line 59 of file Visual.hh.

        {
            return ncvisual_decode (visual);
        }

Here is the call graph for this function:

decode_loop()

int decode_loop ( ) const

inlinenoexcept

Definition at line 64 of file Visual.hh.

        {
            return ncvisual_decode_loop (visual);
        }

Here is the call graph for this function:

geom()

bool geom ( const struct ncvisual_options *  vopts, ncvgeom *  geom  ) const

inline

Definition at line 99 of file Visual.hh.

        {
            return error_guard (ncvisual_geom (get_notcurses (), visual, vopts, geom), -1);
        }

Here is the call graph for this function:

operator ncvisual *()

operator ncvisual * ( ) const

inlinenoexcept

Definition at line 49 of file Visual.hh.

        {
            return visual;
        }

operator ncvisual const *()

operator ncvisual const * ( ) const

inlinenoexcept

Definition at line 54 of file Visual.hh.

        {
            return visual;
        }

polyfill()

int polyfill ( int  y, int  x, uint32_t  rgba  ) const

inline

Definition at line 94 of file Visual.hh.

        {
            return error_guard<int> (ncvisual_polyfill_yx (visual, y, x, rgba), -1);
        }

Here is the call graph for this function:

rotate()

bool rotate ( double  rads ) const

inline

Definition at line 84 of file Visual.hh.

        {
            return error_guard (ncvisual_rotate (visual, rads), -1);
        }

Here is the call graph for this function:

set()

bool set ( int  y, int  x, uint32_t  pixel  ) const

inline

Definition at line 112 of file Visual.hh.

        {
            return error_guard (ncvisual_set_yx (visual, y, x, pixel), -1);
        }

Here is the call graph for this function:

simple_streamer()

bool simple_streamer ( ncvisual_options *  vopts, const timespec *  tspec, void *  curry = nullptr  ) const

inline

Definition at line 89 of file Visual.hh.

        {
            return error_guard (ncvisual_simple_streamer (visual, vopts, tspec, curry), -1);
        }

Here is the call graph for this function:

stream()

int stream ( const ncvisual_options *  vopts, float  timescale, ncstreamcb  streamer, void *  curry = nullptr  ) const

inline

Definition at line 74 of file Visual.hh.

        {
            return error_guard<int> (ncvisual_stream (get_notcurses (), visual, timescale, streamer, vopts, curry), -1);
        }

Here is the call graph for this function:

subtitle()

ncplane * subtitle ( Plane &  parent )

inlinenoexcept

Definition at line 79 of file Visual.hh.

        {
            return ncvisual_subtitle_plane (parent, visual);
        }

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/Visual.hh