Palette Class Reference

#include <Palette.hh>

Inheritance diagram for Palette:

Collaboration diagram for Palette:

Public Member Functions
	Palette (NotCurses *ncinst=nullptr)
	~Palette ()
	operator ncpalette * () noexcept
	operator ncpalette const * () const noexcept
bool	set (int idx, int r, int g, int b) const NOEXCEPT_MAYBE
bool	set (int idx, unsigned rgb) const NOEXCEPT_MAYBE
bool	get (int idx, unsigned *r, unsigned *g, unsigned *b) const
bool	get (int idx, unsigned &r, unsigned &g, unsigned &b) 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 11 of file Palette.hh.

Constructor & Destructor Documentation

Palette()

Palette ( NotCurses *  ncinst = nullptr )

inline

Definition at line 14 of file Palette.hh.

            : Root (ncinst)
        {
            palette = ncpalette_new (get_notcurses ());
            if (palette == nullptr)
                throw init_error ("Notcurses failed to create a new palette");
        }

Here is the call graph for this function:

~Palette()

~Palette ( )

inline

Definition at line 22 of file Palette.hh.

        {
            ncpalette_free (palette);
        }

Here is the call graph for this function:

Member Function Documentation

get() [1/2]

bool get ( int  idx, unsigned &  r, unsigned &  g, unsigned &  b  ) const

inline

Definition at line 59 of file Palette.hh.

        {
            return error_guard (ncpalette_get_rgb8 (palette, idx, &r, &g, &b), -1);
        }

get() [2/2]

bool get ( int  idx, unsigned *  r, unsigned *  g, unsigned *  b  ) const

inline

Definition at line 47 of file Palette.hh.

        {
            if (r == nullptr)
                throw invalid_argument ("'r' must be a valid pointer");
            if (g == nullptr)
                throw invalid_argument ("'g' must be a valid pointer");
            if (b == nullptr)
                throw invalid_argument ("'b' must be a valid pointer");
 
            return get (idx, *r, *g, *b);
        }

operator ncpalette *()

operator ncpalette * ( )

inlinenoexcept

Definition at line 27 of file Palette.hh.

        {
            return palette;
        }

operator ncpalette const *()

operator ncpalette const * ( ) const

inlinenoexcept

Definition at line 32 of file Palette.hh.

        {
            return palette;
        }

set() [1/2]

bool set ( int  idx, int  r, int  g, int  b  ) const

inline

Definition at line 37 of file Palette.hh.

        {
            return error_guard (ncpalette_set_rgb8 (palette, idx, r, g, b), -1);
        }

set() [2/2]

bool set ( int  idx, unsigned  rgb  ) const

inline

Definition at line 42 of file Palette.hh.

        {
            return error_guard (ncpalette_set (palette, idx, rgb), -1);
        }

---

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

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