Notcurses 3.0.13
a blingful library for TUIs and character graphics
Loading...
Searching...
No Matches
Plane Class Reference

#include <Plane.hh>

Inheritance diagram for Plane:
Collaboration diagram for Plane:

Public Member Functions

 Plane (Plane &&other)
 
 Plane (Plane const &other)
 
 Plane (Plane const &other, void *opaque)
 
 Plane (Plane *n, int rows, int cols, int yoff, int xoff, void *opaque=nullptr)
 
 Plane (const Plane *n, int rows, int cols, int yoff, int xoff, void *opaque=nullptr)
 
 Plane (Plane *n, ncplane_options const &nopts, NotCurses *ncinst=nullptr)
 
 Plane (const Plane *n, ncplane_options const &nopts, NotCurses *ncinst=nullptr)
 
 Plane (const Plane &n, int rows, int cols, int yoff, int xoff, void *opaque=nullptr)
 
 Plane (unsigned rows, unsigned cols, int yoff, int xoff, void *opaque=nullptr, NotCurses *ncinst=nullptr)
 
 Plane (Plane &n, int rows, int cols, int yoff, NCAlign align, void *opaque=nullptr)
 
 Plane (Plane const &n, int rows, int cols, int yoff, NCAlign align, void *opaque=nullptr)
 
 Plane (Plane &n, ncplane_options const &nopts, NotCurses *ncinst=nullptr)
 
 Plane (Plane const &n, ncplane_options const &nopts, NotCurses *ncinst=nullptr)
 
 Plane (Plane *n, int rows, int cols, int yoff, NCAlign align, void *opaque=nullptr)
 
 Plane (Plane const *n, int rows, int cols, int yoff, NCAlign align, void *opaque=nullptr)
 
 Plane (ncplane *_plane) noexcept
 
 ~Plane () noexcept
 
 operator ncplane * () noexcept
 
 operator ncplane const * () const noexcept
 
void center_abs (int *y, int *x) const noexcept
 
ncplaneto_ncplane () const noexcept
 
bool resize_maximize () const NOEXCEPT_MAYBE
 
bool resize_realign () const NOEXCEPT_MAYBE
 
bool resize (int keepy, int keepx, int keepleny, int keeplenx, int yoff, int xoff, int ylen, int xlen) const NOEXCEPT_MAYBE
 
bool pulse (const timespec *ts, fadecb fader, void *curry) const NOEXCEPT_MAYBE
 
int gradient (int y, int x, unsigned ylen, unsigned xlen, const char *egc, uint16_t stylemask, uint64_t ul, uint64_t ur, uint64_t ll, uint64_t lr) const NOEXCEPT_MAYBE
 
int gradient2x1 (int y, int x, unsigned ylen, unsigned xlen, uint32_t ul, uint32_t ur, uint32_t ll, uint32_t lr) const NOEXCEPT_MAYBE
 
void greyscale () const noexcept
 
bool resize (int ylen, int xlen) const NOEXCEPT_MAYBE
 
bool fadeout (timespec *ts, fadecb fader=nullptr, void *curry=nullptr) const NOEXCEPT_MAYBE
 
bool fadeout (timespec &ts, fadecb fader=nullptr, void *curry=nullptr) const NOEXCEPT_MAYBE
 
bool fadeout (timespec const &ts, fadecb fader=nullptr, void *curry=nullptr) const NOEXCEPT_MAYBE
 
bool fadeout (const timespec *ts, fadecb fader=nullptr, void *curry=nullptr) const NOEXCEPT_MAYBE
 
bool fadein (timespec *ts, fadecb fader=nullptr) const NOEXCEPT_MAYBE
 
bool fadein (timespec &ts, fadecb fader=nullptr) const NOEXCEPT_MAYBE
 
bool fadein (timespec const &ts, fadecb fader=nullptr) const NOEXCEPT_MAYBE
 
bool fadein (const timespec *ts, fadecb fader=nullptr, void *curry=nullptr) const NOEXCEPT_MAYBE
 
void erase () const noexcept
 
int get_abs_x () const noexcept
 
int get_abs_y () const noexcept
 
int get_x () const noexcept
 
int get_y () const noexcept
 
int get_align (NCAlign align, int c) const NOEXCEPT_MAYBE
 
int get_halign (NCAlign align, int c) const NOEXCEPT_MAYBE
 
int get_valign (NCAlign align, int r) const NOEXCEPT_MAYBE
 
void get_dim (unsigned *rows, unsigned *cols) const noexcept
 
void get_dim (unsigned &rows, unsigned &cols) const noexcept
 
unsigned get_dim_x () const noexcept
 
unsigned get_dim_y () const noexcept
 
void get_abs_yx (int *y, int *x) const noexcept
 
void get_yx (int *y, int *x) const noexcept
 
void get_yx (int &y, int &x) const noexcept
 
Planeget_parent () const noexcept
 
Planereparent (Plane *newparent=nullptr) const noexcept
 
Planereparent (const Plane *newparent) const noexcept
 
Planereparent (const Plane &newparent) const noexcept
 
Planereparent_family (Plane *newparent=nullptr) const noexcept
 
Planereparent_family (const Plane *newparent) const noexcept
 
Planereparent_family (const Plane &newparent) const noexcept
 
void home () const noexcept
 
bool move (int y, int x) const NOEXCEPT_MAYBE
 
void move_top () noexcept
 
void move_bottom () noexcept
 
bool move_below (Plane &below) const NOEXCEPT_MAYBE
 
bool move_below (Plane *below) const
 
bool move_above (Plane &above) const NOEXCEPT_MAYBE
 
bool move_above (Plane *above) const
 
bool mergedown (Plane &dst, unsigned begsrcy, unsigned begsrcx, unsigned leny, unsigned lenx, unsigned dsty, unsigned dstx) const
 
bool mergedown (Plane *dst, int begsrcy, int begsrcx, unsigned leny, unsigned lenx, int dsty, int dstx) const
 
bool mergedown_simple (Plane &dst) const
 
bool mergedown_simple (Plane *dst) const
 
bool cursor_move (int y, int x) const NOEXCEPT_MAYBE
 
void get_cursor_yx (unsigned *y, unsigned *x) const noexcept
 
void get_cursor_yx (unsigned &y, unsigned &x) const noexcept
 
unsigned cursor_y () const noexcept
 
unsigned cursor_x () const noexcept
 
int putc (const Cell &c) const NOEXCEPT_MAYBE
 
int putc (const Cell *c) const
 
int putc (int y, int x, Cell const &c) const NOEXCEPT_MAYBE
 
int putc (int y, int x, Cell const *c) const NOEXCEPT_MAYBE
 
int putc (char c, bool retain_styling=false) const NOEXCEPT_MAYBE
 
int putc (int y, int x, char c) const NOEXCEPT_MAYBE
 
int putc (const char *gclust, size_t *sbytes=nullptr, bool retain_styling=false) const NOEXCEPT_MAYBE
 
int putc (int y, int x, const char *gclust, size_t *sbytes=nullptr) const NOEXCEPT_MAYBE
 
int putc (const wchar_t *gclust, size_t *sbytes=nullptr, bool retain_styling=false) const NOEXCEPT_MAYBE
 
int putc (int y, int x, const wchar_t *gclust, size_t *sbytes=nullptr) const NOEXCEPT_MAYBE
 
int putwch (int y, int x, wchar_t w) const NOEXCEPT_MAYBE
 
int putwch (wchar_t w) const NOEXCEPT_MAYBE
 
int putwc_stained (wchar_t w) const NOEXCEPT_MAYBE
 
int putstr (const char *gclustarr) const NOEXCEPT_MAYBE
 
int putstr (int y, int x, const char *gclustarr) const NOEXCEPT_MAYBE
 
int putstr (int y, NCAlign atype, const char *s) const NOEXCEPT_MAYBE
 
int putstr (const wchar_t *gclustarr) const NOEXCEPT_MAYBE
 
int putstr (int y, int x, const wchar_t *gclustarr) const NOEXCEPT_MAYBE
 
int putstr (int y, NCAlign atype, const wchar_t *gcluststyles) const NOEXCEPT_MAYBE
 
int putstr_stained (const wchar_t *gclustarr) const NOEXCEPT_MAYBE
 
int putstr_stained (const char *s) const NOEXCEPT_MAYBE
 
int printf_stained (const char *format,...) const NOEXCEPT_MAYBE __attribute__((format(printf
 
int va_start (va, format)
 
 va_end (va)
 
return error_guard (ret, -1)
 
int printf (const char *format,...) const NOEXCEPT_MAYBE __attribute__((format(printf
 
int va_start (va, format)
 
 va_end (va)
 
return error_guard (ret, -1)
 
int printf (int y, int x, const char *format,...) const NOEXCEPT_MAYBE __attribute__((format(printf
 
int va_start (va, format)
 
 va_end (va)
 
return error_guard (ret, -1)
 
int printf (int y, NCAlign align, const char *format,...) const NOEXCEPT_MAYBE __attribute__((format(printf
 
int va_start (va, format)
 
 va_end (va)
 
return error_guard (ret, -1)
 
int vprintf_stained (const char *format, va_list ap) const NOEXCEPT_MAYBE
 
int vprintf (const char *format, va_list ap) const NOEXCEPT_MAYBE
 
int vprintf (int y, int x, const char *format, va_list ap) const NOEXCEPT_MAYBE
 
int vprintf (int y, NCAlign align, const char *format, va_list ap) const NOEXCEPT_MAYBE
 
int hline (const Cell &c, unsigned len) const NOEXCEPT_MAYBE
 
int hline (const Cell &c, unsigned len, uint64_t c1, uint64_t c2) const NOEXCEPT_MAYBE
 
int vline (const Cell &c, unsigned len) const NOEXCEPT_MAYBE
 
int vline (const Cell &c, unsigned len, uint64_t c1, uint64_t c2) const NOEXCEPT_MAYBE
 
bool load_box (uint16_t styles, uint64_t channels, Cell &ul, Cell &ur, Cell &ll, Cell &lr, Cell &hl, Cell &vl, const char *gclusters) const NOEXCEPT_MAYBE
 
bool load_box (CellStyle style, uint64_t channels, Cell &ul, Cell &ur, Cell &ll, Cell &lr, Cell &hl, Cell &vl, const char *gclusters) const NOEXCEPT_MAYBE
 
bool load_rounded_box (uint16_t styles, uint64_t channels, Cell &ul, Cell &ur, Cell &ll, Cell &lr, Cell &hl, Cell &vl) const NOEXCEPT_MAYBE
 
bool load_rounded_box (CellStyle style, uint64_t channels, Cell &ul, Cell &ur, Cell &ll, Cell &lr, Cell &hl, Cell &vl) const NOEXCEPT_MAYBE
 
bool load_double_box (uint16_t styles, uint64_t channels, Cell &ul, Cell &ur, Cell &ll, Cell &lr, Cell &hl, Cell &vl) const NOEXCEPT_MAYBE
 
bool load_double_box (CellStyle style, uint64_t channels, Cell &ul, Cell &ur, Cell &ll, Cell &lr, Cell &hl, Cell &vl) const NOEXCEPT_MAYBE
 
bool box (const Cell &ul, const Cell &ur, const Cell &ll, const Cell &lr, const Cell &hline, const Cell &vline, int ystop, int xstop, unsigned ctlword) const NOEXCEPT_MAYBE
 
bool box_sized (const Cell &ul, const Cell &ur, const Cell &ll, const Cell &lr, const Cell &hline, const Cell &vline, int ylen, int xlen, unsigned ctlword) const NOEXCEPT_MAYBE
 
bool rounded_box (uint16_t styles, uint64_t channels, int ystop, int xstop, unsigned ctlword) const NOEXCEPT_MAYBE
 
bool rounded_box_sized (uint16_t styles, uint64_t channels, int ylen, int xlen, unsigned ctlword) const NOEXCEPT_MAYBE
 
bool double_box (uint16_t styles, uint64_t channels, int ystop, int xstop, unsigned ctlword) const NOEXCEPT_MAYBE
 
bool double_box_sized (uint16_t styles, uint64_t channels, int ylen, int xlen, unsigned ctlword) const NOEXCEPT_MAYBE
 
bool perimeter (const Cell &ul, const Cell &ur, const Cell &ll, const Cell &lr, const Cell &hline, const Cell &vline, unsigned ctlword) const NOEXCEPT_MAYBE
 
bool perimeter_rounded (uint16_t stylemask, uint64_t channels, unsigned ctlword) const NOEXCEPT_MAYBE
 
bool perimeter_double (uint16_t stylemask, uint64_t channels, unsigned ctlword) const NOEXCEPT_MAYBE
 
int polyfill (int y, int x, const Cell &c) const NOEXCEPT_MAYBE
 
uint32_trgba (ncblitter_e blit, unsigned begy, unsigned begx, unsigned leny, unsigned lenx) const noexcept
 
charcontent (unsigned begy, unsigned begx, unsigned leny, unsigned lenx) const noexcept
 
uint64_t get_channels () const noexcept
 
unsigned get_bchannel () const noexcept
 
unsigned get_fchannel () const noexcept
 
unsigned get_fg_rgb () const noexcept
 
unsigned get_bg_rgb () const noexcept
 
unsigned get_fg_alpha () const noexcept
 
void set_channels (uint64_t channels) const noexcept
 
bool set_fg_alpha (unsigned alpha) const NOEXCEPT_MAYBE
 
unsigned get_bg_alpha () const noexcept
 
bool set_bg_alpha (unsigned alpha) const NOEXCEPT_MAYBE
 
unsigned get_fg_rgb8 (unsigned *r, unsigned *g, unsigned *b) const noexcept
 
bool set_fg_rgb8 (int r, int g, int b, bool clipped=false) const NOEXCEPT_MAYBE
 
bool set_fg_palindex (int idx) const NOEXCEPT_MAYBE
 
bool set_fg_rgb (uint32_t channel) const NOEXCEPT_MAYBE
 
void set_fg_default () const noexcept
 
unsigned get_bg_rgb8 (unsigned *r, unsigned *g, unsigned *b) const noexcept
 
bool set_bg_rgb8 (int r, int g, int b, bool clipped=false) const NOEXCEPT_MAYBE
 
bool set_bg_palindex (int idx) const NOEXCEPT_MAYBE
 
bool set_bg_rgb (uint32_t channel) const NOEXCEPT_MAYBE
 
void set_bg_default () const noexcept
 
bool set_scrolling (bool scrollp) const noexcept
 
unsigned get_styles () const noexcept
 
void styles_set (CellStyle styles) const noexcept
 
void styles_on (CellStyle styles) const noexcept
 
void styles_off (CellStyle styles) const noexcept
 
int format (int y, int x, unsigned ylen, unsigned xlen, uint16_t stylemask) const NOEXCEPT_MAYBE
 
int stain (int y, int x, unsigned ylen, unsigned xlen, uint64_t ul, uint64_t ur, uint64_t ll, uint64_t lr) const NOEXCEPT_MAYBE
 
Planeget_below () const noexcept
 
Planeget_above () const noexcept
 
bool set_base_cell (Cell &c) const NOEXCEPT_MAYBE
 
bool set_base (const char *egc, uint16_t stylemask, uint64_t channels) const NOEXCEPT_MAYBE
 
bool get_base (Cell &c) const NOEXCEPT_MAYBE
 
int at_cursor (Cell &c) const NOEXCEPT_MAYBE
 
int at_cursor (Cell *c) const noexcept
 
charat_cursor (uint16_t *stylemask, uint64_t *channels) const
 
int get_at (int y, int x, Cell &c) const NOEXCEPT_MAYBE
 
int get_at (int y, int x, Cell *c) const
 
charget_at (int y, int x, uint16_t *stylemask, uint64_t *channels) const
 
voidset_userptr (void *opaque) const noexcept
 
template<typename T >
Tset_userptr (T *opaque) const noexcept
 
voidget_userptr () const noexcept
 
template<typename T >
Tget_userptr () const noexcept
 
NcReelncreel_create (const ncreel_options *popts=nullptr)
 
int load_egc32 (Cell &cell, uint32_t egc) const NOEXCEPT_MAYBE
 
int load (Cell &cell, const char *gcluster) const NOEXCEPT_MAYBE
 
bool load (Cell &cell, char ch) const NOEXCEPT_MAYBE
 
int prime (Cell &cell, const char *gcluster, uint16_t styles, uint64_t channels) const NOEXCEPT_MAYBE
 
void release (Cell &cell) const noexcept
 
int duplicate (Cell &target, Cell &source) const NOEXCEPT_MAYBE
 
int duplicate (Cell &target, Cell const &source) const NOEXCEPT_MAYBE
 
int duplicate (Cell &target, Cell *source) const
 
int duplicate (Cell &target, Cell const *source) const
 
int duplicate (Cell *target, Cell *source) const
 
int duplicate (Cell *target, Cell const *source) const
 
int duplicate (Cell *target, Cell &source) const
 
int duplicate (Cell *target, Cell const &source) const
 
void translate (const Plane *dst, int *y=nullptr, int *x=nullptr) const noexcept
 
void translate (const Plane &dst, int *y=nullptr, int *x=nullptr) const noexcept
 
bool translate_abs (int *y=nullptr, int *x=nullptr) const NOEXCEPT_MAYBE
 
bool rotate_cw () const NOEXCEPT_MAYBE
 
bool rotate_ccw () const noexcept
 
charstrdup (Cell const &cell) const noexcept
 
charextract (Cell const &cell, uint16_t *stylemask=nullptr, uint64_t *channels=nullptr)
 
const charget_extended_gcluster (Cell &cell) const noexcept
 
const charget_extended_gcluster (Cell const &cell) const noexcept
 
bool blit_bgrx (const void *data, int linesize, const struct ncvisual_options *vopts) const NOEXCEPT_MAYBE
 
bool blit_rgba (const void *data, int linesize, const struct ncvisual_options *vopts) const NOEXCEPT_MAYBE
 
int qrcode (unsigned *ymax, unsigned *xmax, const void *data, size_t len) const NOEXCEPT_MAYBE
 
bool is_descendant_of (const Plane &ancestor) const noexcept
 
bool is_fg_default () const noexcept
 
bool is_bg_default () const noexcept
 
bool is_valid () const noexcept
 
void set_resizecb (int(*resizecb)(struct ncplane *)) const noexcept
 
- Public Member Functions inherited from Root
notcursesget_notcurses () const
 
NotCursesget_notcurses_cpp () const
 

Static Public Member Functions

static void translate (const Plane *src, const Plane *dst, int *y=nullptr, int *x=nullptr)
 
static void translate (const Plane &src, const Plane &dst, int *y=nullptr, int *x=nullptr) noexcept
 
static Planemap_plane (ncplane *ncp, Plane *associated_plane=nullptr) noexcept
 

Data Fields

int ret = ncplane_vprintf_stained (plane, format, va)
 

Protected Member Functions

 Plane (ncplane *_plane, bool _is_stdplane)
 
 Plane (NotCurses *ncinst=nullptr)
 
void set_plane (ncplane *_plane)
 
void release_native_plane () noexcept
 
- Protected Member Functions inherited from Root
 Root (NotCurses *ncinst)
 
bool is_notcurses_stopped () const noexcept
 

Static Protected Member Functions

static void unmap_plane (Plane *p) 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)
 

Friends

class NotCurses
 
class NcReel
 
class Tablet
 
class Widget
 
template<typename TPlot , typename TCoord >
class PlotBase
 

Additional Inherited Members

- 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 21 of file Plane.hh.

Constructor & Destructor Documentation

◆ Plane() [1/18]

Plane ( Plane &&  other)
inline

Definition at line 24 of file Plane.hh.

25 : Root (nullptr)
26 {
28
29 plane = other.plane;
30 is_stdplane = other.is_stdplane;
31
32 map_plane (plane, this);
33
34 other.plane = nullptr;
35 other.is_stdplane = false;
36 }
static Plane * map_plane(ncplane *ncp, Plane *associated_plane=nullptr) noexcept
return error_guard(ret, -1)
static void unmap_plane(Plane *p) noexcept
Root(NotCurses *ncinst)
Definition Root.hh:34

◆ Plane() [2/18]

Plane ( Plane const other)
inline

Definition at line 38 of file Plane.hh.

39 : Root (nullptr)
40 {
41 plane = duplicate_plane (other, nullptr);
42 }

◆ Plane() [3/18]

Plane ( Plane const other,
void opaque 
)
inlineexplicit

Definition at line 44 of file Plane.hh.

45 : Root (nullptr)
46 {
47 plane = duplicate_plane (other, opaque);
48 }

◆ Plane() [4/18]

Plane ( Plane n,
int  rows,
int  cols,
int  yoff,
int  xoff,
void opaque = nullptr 
)
inlineexplicit

Definition at line 50 of file Plane.hh.

51 : Plane (static_cast<const Plane*>(n), rows, cols, yoff, xoff, opaque)
52 {}
Plane(Plane &&other)
Definition Plane.hh:24
vopts n
Definition notcurses.h:3502

◆ Plane() [5/18]

Plane ( const Plane n,
int  rows,
int  cols,
int  yoff,
int  xoff,
void opaque = nullptr 
)
inlineexplicit

Definition at line 54 of file Plane.hh.

55 : Root (nullptr)
56 {
57 if (n == nullptr)
58 throw invalid_argument ("'n' must be a valid pointer");
59
60 plane = create_plane (*n, rows, cols, yoff, xoff, opaque);
61 }

◆ Plane() [6/18]

Plane ( Plane n,
ncplane_options const nopts,
NotCurses ncinst = nullptr 
)
inlineexplicit

Definition at line 63 of file Plane.hh.

64 : Plane (static_cast<const Plane*>(n), nopts, ncinst)
65 {}

◆ Plane() [7/18]

Plane ( const Plane n,
ncplane_options const nopts,
NotCurses ncinst = nullptr 
)
inlineexplicit

Definition at line 67 of file Plane.hh.

68 : Root (ncinst)
69 {
70 if (n == nullptr) {
71 throw invalid_argument ("'n' must be a valid pointer");
72 }
73
74 plane = create_plane (*n, nopts);
75 }

◆ Plane() [8/18]

Plane ( const Plane n,
int  rows,
int  cols,
int  yoff,
int  xoff,
void opaque = nullptr 
)
inlineexplicit

Definition at line 77 of file Plane.hh.

78 : Root (nullptr)
79 {
80 plane = create_plane (n, rows, cols, yoff, xoff, opaque);
81 }

◆ Plane() [9/18]

Plane ( unsigned  rows,
unsigned  cols,
int  yoff,
int  xoff,
void opaque = nullptr,
NotCurses ncinst = nullptr 
)
inlineexplicit

Definition at line 83 of file Plane.hh.

84 : Root (ncinst)
85 {
87 .y = yoff,
88 .x = xoff,
89 .rows = rows,
90 .cols = cols,
91 .userptr = opaque,
92 .name = nullptr,
93 .resizecb = nullptr,
94 .flags = 0,
95 .margin_b = 0,
96 .margin_r = 0,
97 };
98 plane = ncplane_create (
100 &nopts
101 );
102
103 if (plane == nullptr)
104 throw init_error ("Notcurses failed to create a new plane");
105
106 map_plane (plane, this);
107 }
notcurses * get_notcurses() const
ncplane * notcurses_stdplane(notcurses *nc)
Definition notcurses.c:699
ncplane * ncplane_create(ncplane *n, const ncplane_options *nopts)
Definition notcurses.c:707
Here is the call graph for this function:

◆ Plane() [10/18]

Plane ( Plane n,
int  rows,
int  cols,
int  yoff,
NCAlign  align,
void opaque = nullptr 
)
inlineexplicit

Definition at line 109 of file Plane.hh.

110 : Root (nullptr)
111 {
112 plane = create_plane (n, rows, cols, yoff, align, opaque);
113 }

◆ Plane() [11/18]

Plane ( Plane const n,
int  rows,
int  cols,
int  yoff,
NCAlign  align,
void opaque = nullptr 
)
inlineexplicit

Definition at line 115 of file Plane.hh.

116 : Root (nullptr)
117 {
118 plane = create_plane (const_cast<Plane&>(n), rows, cols, yoff, align, opaque);
119 }

◆ Plane() [12/18]

Plane ( Plane n,
ncplane_options const nopts,
NotCurses ncinst = nullptr 
)
inlineexplicit

Definition at line 121 of file Plane.hh.

122 : Plane (static_cast<Plane const&>(n), nopts, ncinst)
123 {}

◆ Plane() [13/18]

Plane ( Plane const n,
ncplane_options const nopts,
NotCurses ncinst = nullptr 
)
inlineexplicit

Definition at line 125 of file Plane.hh.

126 : Root (ncinst)
127 {
128 plane = create_plane (n, nopts);
129 }

◆ Plane() [14/18]

Plane ( Plane n,
int  rows,
int  cols,
int  yoff,
NCAlign  align,
void opaque = nullptr 
)
inlineexplicit

Definition at line 131 of file Plane.hh.

132 : Root (nullptr)
133 {
134 if (n == nullptr)
135 throw invalid_argument ("'n' must be a valid pointer");
136
137 plane = create_plane (*n, rows, cols, yoff, align, opaque);
138 }

◆ Plane() [15/18]

Plane ( Plane const n,
int  rows,
int  cols,
int  yoff,
NCAlign  align,
void opaque = nullptr 
)
inlineexplicit

Definition at line 140 of file Plane.hh.

141 : Root (nullptr)
142 {
143 if (n == nullptr)
144 throw invalid_argument ("'n' must be a valid pointer");
145
146 plane = create_plane (const_cast<Plane&>(*n), rows, cols, yoff, align, opaque);
147 }

◆ Plane() [16/18]

Plane ( ncplane _plane)
inlineexplicitnoexcept

Definition at line 149 of file Plane.hh.

150 : Root (nullptr),
151 plane (_plane)
152 {}

◆ ~Plane()

~Plane ( )
inlinenoexcept

Definition at line 154 of file Plane.hh.

155 {
156 if (is_stdplane || plane == nullptr)
157 return;
158
159 if (!is_notcurses_stopped ())
160 ncplane_destroy (plane);
161 unmap_plane (this);
162 }
bool is_notcurses_stopped() const noexcept
int ncplane_destroy(ncplane *ncp)
Definition notcurses.c:1018
Here is the call graph for this function:

◆ Plane() [17/18]

Plane ( ncplane _plane,
bool  _is_stdplane 
)
inlineexplicitprotected

Definition at line 1250 of file Plane.hh.

1251 : Root (nullptr),
1252 plane (_plane),
1253 is_stdplane (_is_stdplane)
1254 {
1255 if (_plane == nullptr)
1256 throw invalid_argument ("_plane must be a valid pointer");
1257 }

◆ Plane() [18/18]

Plane ( NotCurses ncinst = nullptr)
inlineprotected

Definition at line 1261 of file Plane.hh.

1262 : Root (ncinst),
1263 plane (nullptr)
1264 {}

Member Function Documentation

◆ at_cursor() [1/3]

int at_cursor ( Cell c) const
inline

Definition at line 989 of file Plane.hh.

990 {
991 return error_guard<int>(ncplane_at_cursor_cell (plane, c), -1);
992 }
const nccell * c
Definition egcpool.h:296
int ncplane_at_cursor_cell(ncplane *n, nccell *c)
Definition notcurses.c:266
Here is the call graph for this function:

◆ at_cursor() [2/3]

int at_cursor ( Cell c) const
inlinenoexcept

Definition at line 994 of file Plane.hh.

995 {
996 if (c == nullptr)
997 return false;
998
999 return at_cursor (*c);
1000 }
int at_cursor(Cell &c) const NOEXCEPT_MAYBE
Definition Plane.hh:989

◆ at_cursor() [3/3]

char * at_cursor ( uint16_t stylemask,
uint64_t channels 
) const
inline

Definition at line 1002 of file Plane.hh.

1003 {
1004 if (stylemask == nullptr || channels == nullptr)
1005 return nullptr;
1006
1007 return ncplane_at_cursor (plane, stylemask, channels);
1008 }
char * ncplane_at_cursor(const ncplane *n, uint16_t *stylemask, uint64_t *channels)
Definition notcurses.c:210
Here is the call graph for this function:

◆ blit_bgrx()

bool blit_bgrx ( const void data,
int  linesize,
const struct ncvisual_options vopts 
) const
inline

Definition at line 1206 of file Plane.hh.

1207 {
1208 bool ret = ncblit_bgrx (data, linesize, vopts) < 0;
1210 }
int ncblit_bgrx(const void *data, int linesize, const struct ncvisual_options *vopts)
Definition blit.c:1408
const struct ncplane_options struct ncvisual struct ncvisual_options * vopts
Definition notcurses.h:3484
Here is the call graph for this function:

◆ blit_rgba()

bool blit_rgba ( const void data,
int  linesize,
const struct ncvisual_options vopts 
) const
inline

Definition at line 1212 of file Plane.hh.

1213 {
1214 bool ret = ncblit_rgba (data, linesize, vopts) < 0;
1216 }
int ncblit_rgba(const void *data, int linesize, const struct ncvisual_options *vopts)
Definition blit.c:1454
Here is the call graph for this function:

◆ box()

bool box ( const Cell ul,
const Cell ur,
const Cell ll,
const Cell lr,
const Cell hline,
const Cell vline,
int  ystop,
int  xstop,
unsigned  ctlword 
) const
inline

Definition at line 752 of file Plane.hh.

755 {
756 return error_guard (ncplane_box (plane, ul, ur, ll, lr, hline, vline, ystop, xstop, ctlword), -1);
757 }
int vline(const Cell &c, unsigned len) const NOEXCEPT_MAYBE
Definition Plane.hh:712
int hline(const Cell &c, unsigned len) const NOEXCEPT_MAYBE
Definition Plane.hh:702
API int API int API int uint64_t uint64_t uint64_t uint64_t lr
Definition direct.h:216
API int API int API int uint64_t uint64_t uint64_t uint64_t unsigned unsigned unsigned ctlword
Definition direct.h:217
API int API int API int uint64_t uint64_t uint64_t ll
Definition direct.h:216
API int API int API int uint64_t ul
Definition direct.h:215
API int API int API int uint64_t uint64_t ur
Definition direct.h:215
int ncplane_box(ncplane *n, const nccell *ul, const nccell *ur, const nccell *ll, const nccell *lr, const nccell *hl, const nccell *vl, unsigned ystop, unsigned xstop, unsigned ctlword)
Definition notcurses.c:2271
Here is the call graph for this function:

◆ box_sized()

bool box_sized ( const Cell ul,
const Cell ur,
const Cell ll,
const Cell lr,
const Cell hline,
const Cell vline,
int  ylen,
int  xlen,
unsigned  ctlword 
) const
inline

Definition at line 759 of file Plane.hh.

762 {
763 return error_guard (ncplane_box_sized (plane, ul, ur, ll, lr, hline, vline, ylen, xlen, ctlword), -1);
764 }
API int API int API int uint64_t uint64_t uint64_t uint64_t unsigned unsigned xlen
Definition direct.h:217
API int API int API int uint64_t uint64_t uint64_t uint64_t unsigned ylen
Definition direct.h:217

◆ center_abs()

void center_abs ( int y,
int x 
) const
inlinenoexcept

Definition at line 174 of file Plane.hh.

175 {
176 ncplane_center_abs (plane, y, x);
177 }
void ncplane_center_abs(const ncplane *n, int *RESTRICT y, int *RESTRICT x)
Definition notcurses.c:3268
int y
Definition notcurses.h:1905
int int x
Definition notcurses.h:1905
Here is the call graph for this function:

◆ content()

char * content ( unsigned  begy,
unsigned  begx,
unsigned  leny,
unsigned  lenx 
) const
inlinenoexcept

Definition at line 811 of file Plane.hh.

812 {
813 return ncplane_contents (plane, begy, begx, leny, lenx);
814 }
char * ncplane_contents(ncplane *nc, int begy, int begx, unsigned leny, unsigned lenx)
Definition notcurses.c:3228
Here is the call graph for this function:

◆ cursor_move()

bool cursor_move ( int  y,
int  x 
) const
inline

Definition at line 471 of file Plane.hh.

472 {
473 return error_guard (ncplane_cursor_move_yx (plane, y, x), -1);
474 }
int ncplane_cursor_move_yx(ncplane *n, int y, int x)
Definition notcurses.c:720
Here is the call graph for this function:

◆ cursor_x()

unsigned cursor_x ( ) const
inlinenoexcept

Definition at line 491 of file Plane.hh.

492 {
493 return ncplane_cursor_x(plane);
494 }

◆ cursor_y()

unsigned cursor_y ( ) const
inlinenoexcept

Definition at line 486 of file Plane.hh.

487 {
488 return ncplane_cursor_y(plane);
489 }

◆ double_box()

bool double_box ( uint16_t  styles,
uint64_t  channels,
int  ystop,
int  xstop,
unsigned  ctlword 
) const
inline

Definition at line 776 of file Plane.hh.

777 {
778 return error_guard (ncplane_double_box (plane, styles, channels, ystop, xstop, ctlword), -1);
779 }

◆ double_box_sized()

bool double_box_sized ( uint16_t  styles,
uint64_t  channels,
int  ylen,
int  xlen,
unsigned  ctlword 
) const
inline

Definition at line 781 of file Plane.hh.

782 {
783 return error_guard (ncplane_double_box_sized (plane, styles, channels, ylen, xlen, ctlword), -1);
784 }

◆ duplicate() [1/8]

int duplicate ( Cell target,
Cell source 
) const
inline

Definition at line 1084 of file Plane.hh.

1085 {
1086 return error_guard<int> (nccell_duplicate (plane, target, source), -1);
1087 }
int nccell_duplicate(ncplane *n, nccell *targ, const nccell *c)
Definition render.c:133
Here is the call graph for this function:

◆ duplicate() [2/8]

int duplicate ( Cell target,
Cell source 
) const
inline

Definition at line 1094 of file Plane.hh.

1095 {
1096 if (source == nullptr)
1097 throw invalid_argument ("'source' must be a valid pointer");
1098
1099 return duplicate (target, *source);
1100 }
int duplicate(Cell &target, Cell &source) const NOEXCEPT_MAYBE
Definition Plane.hh:1084

◆ duplicate() [3/8]

int duplicate ( Cell target,
Cell const source 
) const
inline

Definition at line 1089 of file Plane.hh.

1090 {
1091 return error_guard<int> (nccell_duplicate (plane, target, source), -1);
1092 }
Here is the call graph for this function:

◆ duplicate() [4/8]

int duplicate ( Cell target,
Cell const source 
) const
inline

Definition at line 1102 of file Plane.hh.

1103 {
1104 if (source == nullptr)
1105 throw invalid_argument ("'source' must be a valid pointer");
1106
1107 return duplicate (target, *source);
1108 }

◆ duplicate() [5/8]

int duplicate ( Cell target,
Cell source 
) const
inline

Definition at line 1130 of file Plane.hh.

1131 {
1132 if (target == nullptr)
1133 throw invalid_argument ("'target' must be a valid pointer");
1134
1135 return duplicate (*target, source);
1136 }

◆ duplicate() [6/8]

int duplicate ( Cell target,
Cell source 
) const
inline

Definition at line 1110 of file Plane.hh.

1111 {
1112 if (target == nullptr)
1113 throw invalid_argument ("'target' must be a valid pointer");
1114 if (source == nullptr)
1115 throw invalid_argument ("'source' must be a valid pointer");
1116
1117 return duplicate (*target, *source);
1118 }

◆ duplicate() [7/8]

int duplicate ( Cell target,
Cell const source 
) const
inline

Definition at line 1138 of file Plane.hh.

1139 {
1140 if (target == nullptr)
1141 throw invalid_argument ("'target' must be a valid pointer");
1142
1143 return duplicate (*target, source);
1144 }

◆ duplicate() [8/8]

int duplicate ( Cell target,
Cell const source 
) const
inline

Definition at line 1120 of file Plane.hh.

1121 {
1122 if (target == nullptr)
1123 throw invalid_argument ("'target' must be a valid pointer");
1124 if (source == nullptr)
1125 throw invalid_argument ("'source' must be a valid pointer");
1126
1127 return duplicate (*target, *source);
1128 }

◆ erase()

void erase ( ) const
inlinenoexcept

Definition at line 276 of file Plane.hh.

277 {
278 ncplane_erase (plane);
279 }
void ncplane_erase(ncplane *n)
Definition notcurses.c:2458
Here is the call graph for this function:

◆ error_guard() [1/4]

return error_guard ( ret  ,
1 
)

◆ error_guard() [2/4]

return error_guard ( ret  ,
1 
)

◆ error_guard() [3/4]

return error_guard ( ret  ,
1 
)

◆ error_guard() [4/4]

return error_guard ( ret  ,
1 
)

◆ extract()

char * extract ( Cell const cell,
uint16_t stylemask = nullptr,
uint64_t channels = nullptr 
)
inline

Definition at line 1189 of file Plane.hh.

1190 {
1191 return nccell_extract (plane, cell, stylemask, channels);
1192 }

◆ fadein() [1/4]

bool fadein ( const timespec ts,
fadecb  fader = nullptr,
void curry = nullptr 
) const
inline

Definition at line 271 of file Plane.hh.

272 {
273 return error_guard (ncplane_fadein (plane, ts, fader, curry), -1);
274 }
int ncplane_fadein(ncplane *n, const struct timespec *ts, fadecb fader, void *curry)
Definition fade.c:284
Here is the call graph for this function:

◆ fadein() [2/4]

bool fadein ( timespec ts,
fadecb  fader = nullptr 
) const
inline

Definition at line 261 of file Plane.hh.

262 {
263 return fadein (&ts, fader);
264 }
bool fadein(timespec *ts, fadecb fader=nullptr) const NOEXCEPT_MAYBE
Definition Plane.hh:256

◆ fadein() [3/4]

bool fadein ( timespec ts,
fadecb  fader = nullptr 
) const
inline

Definition at line 256 of file Plane.hh.

257 {
258 return fadein (static_cast<const timespec*>(ts), fader);
259 }

◆ fadein() [4/4]

bool fadein ( timespec const ts,
fadecb  fader = nullptr 
) const
inline

Definition at line 266 of file Plane.hh.

267 {
268 return fadein (&ts, fader);
269 }

◆ fadeout() [1/4]

bool fadeout ( const timespec ts,
fadecb  fader = nullptr,
void curry = nullptr 
) const
inline

Definition at line 251 of file Plane.hh.

252 {
253 return error_guard (ncplane_fadeout (plane, ts, fader, curry), -1);
254 }
int ncplane_fadeout(ncplane *n, const struct timespec *ts, fadecb fader, void *curry)
Definition fade.c:260
Here is the call graph for this function:

◆ fadeout() [2/4]

bool fadeout ( timespec ts,
fadecb  fader = nullptr,
void curry = nullptr 
) const
inline

Definition at line 241 of file Plane.hh.

242 {
243 return fadeout (&ts, fader, curry);
244 }
bool fadeout(timespec *ts, fadecb fader=nullptr, void *curry=nullptr) const NOEXCEPT_MAYBE
Definition Plane.hh:236

◆ fadeout() [3/4]

bool fadeout ( timespec ts,
fadecb  fader = nullptr,
void curry = nullptr 
) const
inline

Definition at line 236 of file Plane.hh.

237 {
238 return fadeout (static_cast<const timespec*>(ts), fader, curry);
239 }

◆ fadeout() [4/4]

bool fadeout ( timespec const ts,
fadecb  fader = nullptr,
void curry = nullptr 
) const
inline

Definition at line 246 of file Plane.hh.

247 {
248 return fadeout (&ts, fader, curry);
249 }

◆ format()

int format ( int  y,
int  x,
unsigned  ylen,
unsigned  xlen,
uint16_t  stylemask 
) const
inline

Definition at line 951 of file Plane.hh.

952 {
953 return error_guard<int> (ncplane_format (plane, y, x, ylen, xlen, stylemask), -1);
954 }
int ncplane_format(ncplane *n, int y, int x, unsigned ylen, unsigned xlen, uint16_t stylemask)
Definition fill.c:296
Here is the call graph for this function:

◆ get_above()

Plane * get_above ( ) const
inlinenoexcept

Definition at line 966 of file Plane.hh.

967 {
968 return map_plane (ncplane_above (plane));
969 }
ncplane * ncplane_above(ncplane *n)
Definition notcurses.c:2552
Here is the call graph for this function:

◆ get_abs_x()

int get_abs_x ( ) const
inlinenoexcept

Definition at line 281 of file Plane.hh.

282 {
283 return ncplane_abs_x (plane);
284 }
int ncplane_abs_x(const ncplane *n)
Definition notcurses.c:2638
Here is the call graph for this function:

◆ get_abs_y()

int get_abs_y ( ) const
inlinenoexcept

Definition at line 286 of file Plane.hh.

287 {
288 return ncplane_abs_y (plane);
289 }
int ncplane_abs_y(const ncplane *n)
Definition notcurses.c:2634
Here is the call graph for this function:

◆ get_abs_yx()

void get_abs_yx ( int y,
int x 
) const
inlinenoexcept

Definition at line 336 of file Plane.hh.

337 {
338 ncplane_abs_yx (plane, y, x);
339 }
void ncplane_abs_yx(const ncplane *n, int *RESTRICT y, int *RESTRICT x)
Definition notcurses.c:2642
Here is the call graph for this function:

◆ get_align()

int get_align ( NCAlign  align,
int  c 
) const
inline

Definition at line 301 of file Plane.hh.

302 {
303 return error_guard<int> (ncplane_halign (plane, static_cast<ncalign_e>(align), c), INT_MAX);
304 }
ncalign_e
Definition notcurses.h:80

◆ get_at() [1/3]

int get_at ( int  y,
int  x,
Cell c 
) const
inline

Definition at line 1010 of file Plane.hh.

1011 {
1012 return error_guard<int> (ncplane_at_yx_cell (plane, y, x, c), -1);
1013 }
int ncplane_at_yx_cell(ncplane *n, int y, int x, nccell *c)
Definition notcurses.c:270
Here is the call graph for this function:

◆ get_at() [2/3]

int get_at ( int  y,
int  x,
Cell c 
) const
inline

Definition at line 1015 of file Plane.hh.

1016 {
1017 if (c == nullptr)
1018 return -1;
1019
1020 return get_at (y, x, *c);
1021 }
int get_at(int y, int x, Cell &c) const NOEXCEPT_MAYBE
Definition Plane.hh:1010

◆ get_at() [3/3]

char * get_at ( int  y,
int  x,
uint16_t stylemask,
uint64_t channels 
) const
inline

Definition at line 1023 of file Plane.hh.

1024 {
1025 if (stylemask == nullptr || channels == nullptr)
1026 return nullptr;
1027
1028 return ncplane_at_yx (plane, y, x, stylemask, channels);
1029 }
char * ncplane_at_yx(const ncplane *n, int y, int x, uint16_t *stylemask, uint64_t *channels)
Definition notcurses.c:214
Here is the call graph for this function:

◆ get_base()

bool get_base ( Cell c) const
inline

Definition at line 983 of file Plane.hh.

984 {
985 bool ret = ncplane_base (plane, c) < 0;
987 }
int ncplane_base(ncplane *ncp, nccell *c)
Definition notcurses.c:1569
Here is the call graph for this function:

◆ get_bchannel()

unsigned get_bchannel ( ) const
inlinenoexcept

Definition at line 821 of file Plane.hh.

822 {
823 return ncplane_bchannel (plane);
824 }

◆ get_below()

Plane * get_below ( ) const
inlinenoexcept

Definition at line 961 of file Plane.hh.

962 {
963 return map_plane (ncplane_below (plane));
964 }
ncplane * ncplane_below(ncplane *n)
Definition notcurses.c:2548
Here is the call graph for this function:

◆ get_bg_alpha()

unsigned get_bg_alpha ( ) const
inlinenoexcept

Definition at line 856 of file Plane.hh.

857 {
858 return ncplane_bg_alpha (plane);
859 }

◆ get_bg_rgb()

unsigned get_bg_rgb ( ) const
inlinenoexcept

Definition at line 836 of file Plane.hh.

837 {
838 return ncplane_bg_rgb (plane);
839 }

◆ get_bg_rgb8()

unsigned get_bg_rgb8 ( unsigned r,
unsigned g,
unsigned b 
) const
inlinenoexcept

Definition at line 896 of file Plane.hh.

897 {
898 return ncplane_bg_rgb8 (plane, r, g, b);
899 }
int r
Definition fbuf.h:226

◆ get_channels()

uint64_t get_channels ( ) const
inlinenoexcept

Definition at line 816 of file Plane.hh.

817 {
818 return ncplane_channels (plane);
819 }
uint64_t ncplane_channels(const ncplane *n)
Definition notcurses.c:1490
Here is the call graph for this function:

◆ get_cursor_yx() [1/2]

void get_cursor_yx ( unsigned y,
unsigned x 
) const
inlinenoexcept

Definition at line 481 of file Plane.hh.

482 {
483 get_cursor_yx (&y, &x);
484 }
void get_cursor_yx(unsigned *y, unsigned *x) const noexcept
Definition Plane.hh:476

◆ get_cursor_yx() [2/2]

void get_cursor_yx ( unsigned y,
unsigned x 
) const
inlinenoexcept

Definition at line 476 of file Plane.hh.

477 {
478 ncplane_cursor_yx (plane, y, x);
479 }
void ncplane_cursor_yx(const ncplane *n, unsigned *y, unsigned *x)
Definition notcurses.c:1741
Here is the call graph for this function:

◆ get_dim() [1/2]

void get_dim ( unsigned rows,
unsigned cols 
) const
inlinenoexcept

Definition at line 321 of file Plane.hh.

322 {
323 get_dim (&rows, &cols);
324 }
void get_dim(unsigned *rows, unsigned *cols) const noexcept
Definition Plane.hh:316

◆ get_dim() [2/2]

void get_dim ( unsigned rows,
unsigned cols 
) const
inlinenoexcept

Definition at line 316 of file Plane.hh.

317 {
318 ncplane_dim_yx (plane, rows, cols);
319 }
void ncplane_dim_yx(const ncplane *n, unsigned *rows, unsigned *cols)
Definition notcurses.c:301
Here is the call graph for this function:

◆ get_dim_x()

unsigned get_dim_x ( ) const
inlinenoexcept

Definition at line 326 of file Plane.hh.

327 {
328 return ncplane_dim_x (plane);
329 }

◆ get_dim_y()

unsigned get_dim_y ( ) const
inlinenoexcept

Definition at line 331 of file Plane.hh.

332 {
333 return ncplane_dim_y (plane);
334 }

◆ get_extended_gcluster() [1/2]

const char * get_extended_gcluster ( Cell cell) const
inlinenoexcept

Definition at line 1194 of file Plane.hh.

1195 {
1196 return nccell_extended_gcluster (plane, cell);
1197 }
const char * nccell_extended_gcluster(const ncplane *n, const nccell *c)
Definition notcurses.c:1573
Here is the call graph for this function:

◆ get_extended_gcluster() [2/2]

const char * get_extended_gcluster ( Cell const cell) const
inlinenoexcept

Definition at line 1199 of file Plane.hh.

1200 {
1201 return nccell_extended_gcluster (plane, cell);
1202 }
Here is the call graph for this function:

◆ get_fchannel()

unsigned get_fchannel ( ) const
inlinenoexcept

Definition at line 826 of file Plane.hh.

827 {
828 return ncplane_fchannel (plane);
829 }

◆ get_fg_alpha()

unsigned get_fg_alpha ( ) const
inlinenoexcept

Definition at line 841 of file Plane.hh.

842 {
843 return ncplane_fg_alpha (plane);
844 }

◆ get_fg_rgb()

unsigned get_fg_rgb ( ) const
inlinenoexcept

Definition at line 831 of file Plane.hh.

832 {
833 return ncplane_fg_rgb (plane);
834 }

◆ get_fg_rgb8()

unsigned get_fg_rgb8 ( unsigned r,
unsigned g,
unsigned b 
) const
inlinenoexcept

Definition at line 866 of file Plane.hh.

867 {
868 return ncplane_fg_rgb8 (plane, r, g, b);
869 }

◆ get_halign()

int get_halign ( NCAlign  align,
int  c 
) const
inline

Definition at line 306 of file Plane.hh.

307 {
308 return error_guard<int> (ncplane_halign (plane, static_cast<ncalign_e>(align), c), INT_MAX);
309 }

◆ get_parent()

Plane * get_parent ( ) const
inlinenoexcept

Definition at line 351 of file Plane.hh.

352 {
353 ncplane *ret = ncplane_parent (plane);
354 if (ret == nullptr) {
355 return nullptr;
356 }
357
358 return map_plane (ret);
359 }
ncplane * ncplane_parent(ncplane *n)
Definition notcurses.c:2651
Here is the call graph for this function:

◆ get_styles()

unsigned get_styles ( ) const
inlinenoexcept

Definition at line 931 of file Plane.hh.

932 {
933 return ncplane_styles (plane);
934 }
uint16_t ncplane_styles(const ncplane *n)
Definition notcurses.c:1498
Here is the call graph for this function:

◆ get_userptr() [1/2]

void * get_userptr ( ) const
inlinenoexcept

Definition at line 1042 of file Plane.hh.

1043 {
1044 return ncplane_userptr (plane);
1045 }
void * ncplane_userptr(ncplane *n)
Definition notcurses.c:192
Here is the call graph for this function:

◆ get_userptr() [2/2]

template<typename T >
T * get_userptr ( ) const
inlinenoexcept

Definition at line 1048 of file Plane.hh.

1049 {
1050 return static_cast<T*>(get_userptr ());
1051 }
void * get_userptr() const noexcept
Definition Plane.hh:1042

◆ get_valign()

int get_valign ( NCAlign  align,
int  r 
) const
inline

Definition at line 311 of file Plane.hh.

312 {
313 return error_guard<int> (ncplane_valign (plane, static_cast<ncalign_e>(align), r), INT_MAX);
314 }

◆ get_x()

int get_x ( ) const
inlinenoexcept

Definition at line 291 of file Plane.hh.

292 {
293 return ncplane_x (plane);
294 }
int ncplane_x(const ncplane *n)
Definition notcurses.c:2441
Here is the call graph for this function:

◆ get_y()

int get_y ( ) const
inlinenoexcept

Definition at line 296 of file Plane.hh.

297 {
298 return ncplane_y (plane);
299 }
int ncplane_y(const ncplane *n)
Definition notcurses.c:2434
Here is the call graph for this function:

◆ get_yx() [1/2]

void get_yx ( int y,
int x 
) const
inlinenoexcept

Definition at line 346 of file Plane.hh.

347 {
348 get_yx (&y, &x);
349 }
void get_yx(int *y, int *x) const noexcept
Definition Plane.hh:341

◆ get_yx() [2/2]

void get_yx ( int y,
int x 
) const
inlinenoexcept

Definition at line 341 of file Plane.hh.

342 {
343 ncplane_yx (plane, y, x);
344 }
void ncplane_yx(const ncplane *n, int *y, int *x)
Definition notcurses.c:2448
Here is the call graph for this function:

◆ gradient()

int gradient ( int  y,
int  x,
unsigned  ylen,
unsigned  xlen,
const char egc,
uint16_t  stylemask,
uint64_t  ul,
uint64_t  ur,
uint64_t  ll,
uint64_t  lr 
) const
inline

Definition at line 216 of file Plane.hh.

217 {
218 return error_guard<int> (ncplane_gradient (plane, y, x, ylen, xlen, egc, stylemask, ul, ur, ll, lr), -1);
219 }
const char * egc
Definition egcpool.h:173
int ncplane_gradient(ncplane *n, int y, int x, unsigned ylen, unsigned xlen, const char *egc, uint16_t stylemask, uint64_t ul, uint64_t ur, uint64_t bl, uint64_t br)
Definition fill.c:227
Here is the call graph for this function:

◆ gradient2x1()

int gradient2x1 ( int  y,
int  x,
unsigned  ylen,
unsigned  xlen,
uint32_t  ul,
uint32_t  ur,
uint32_t  ll,
uint32_t  lr 
) const
inline

Definition at line 221 of file Plane.hh.

222 {
223 return error_guard<int> (ncplane_gradient2x1 (plane, y, x, ylen, xlen, ul, ur, ll, lr), -1);
224 }
int ncplane_gradient2x1(ncplane *n, int y, int x, unsigned ylen, unsigned xlen, uint32_t ul, uint32_t ur, uint32_t ll, uint32_t lr)
Definition fill.c:179
Here is the call graph for this function:

◆ greyscale()

void greyscale ( ) const
inlinenoexcept

Definition at line 226 of file Plane.hh.

227 {
228 ncplane_greyscale (plane);
229 }
void ncplane_greyscale(ncplane *n)
Definition fill.c:3
Here is the call graph for this function:

◆ hline() [1/2]

int hline ( const Cell c,
unsigned  len 
) const
inline

Definition at line 702 of file Plane.hh.

703 {
704 return error_guard<int> (ncplane_hline (plane, c, len), -1);
705 }
API int API int const nccell unsigned len
Definition notcurses.h:2588

◆ hline() [2/2]

int hline ( const Cell c,
unsigned  len,
uint64_t  c1,
uint64_t  c2 
) const
inline

Definition at line 707 of file Plane.hh.

708 {
709 return error_guard<int> (ncplane_hline_interp (plane, c, len, c1, c2), -1);
710 }
int ncplane_hline_interp(ncplane *n, const nccell *c, unsigned len, uint64_t c1, uint64_t c2)
Definition notcurses.c:2153
Here is the call graph for this function:

◆ home()

void home ( ) const
inlinenoexcept

Definition at line 399 of file Plane.hh.

400 {
401 ncplane_home (plane);
402 }
void ncplane_home(ncplane *n)
Definition notcurses.c:715
Here is the call graph for this function:

◆ is_bg_default()

bool is_bg_default ( ) const
inlinenoexcept

Definition at line 1234 of file Plane.hh.

1235 {
1236 return ncplane_bg_default_p (plane);
1237 }

◆ is_descendant_of()

bool is_descendant_of ( const Plane ancestor) const
inlinenoexcept

Definition at line 1224 of file Plane.hh.

1225 {
1226 return ncplane_descendant_p (plane, ancestor) != 0;
1227 }

◆ is_fg_default()

bool is_fg_default ( ) const
inlinenoexcept

Definition at line 1229 of file Plane.hh.

1230 {
1231 return ncplane_fg_default_p (plane);
1232 }

◆ is_valid()

bool is_valid ( ) const
inlinenoexcept

Definition at line 1239 of file Plane.hh.

1240 {
1241 return plane != nullptr;
1242 }
Here is the caller graph for this function:

◆ load() [1/2]

bool load ( Cell cell,
char  ch 
) const
inline

Definition at line 1069 of file Plane.hh.

1070 {
1071 return error_guard (nccell_load_char (plane, cell, ch), -1);
1072 }

◆ load() [2/2]

int load ( Cell cell,
const char gcluster 
) const
inline

Definition at line 1064 of file Plane.hh.

1065 {
1066 return error_guard<int> (nccell_load (plane, cell, gcluster), -1);
1067 }
int nccell_load(ncplane *n, nccell *c, const char *gcluster)
Definition notcurses.c:1833
Here is the call graph for this function:

◆ load_box() [1/2]

bool load_box ( CellStyle  style,
uint64_t  channels,
Cell ul,
Cell ur,
Cell ll,
Cell lr,
Cell hl,
Cell vl,
const char gclusters 
) const
inline

Definition at line 727 of file Plane.hh.

728 {
729 return load_box (static_cast<uint16_t>(style), channels, ul, ur, ll, lr, hl, vl, gclusters);
730 }
bool load_box(uint16_t styles, uint64_t channels, Cell &ul, Cell &ur, Cell &ll, Cell &lr, Cell &hl, Cell &vl, const char *gclusters) const NOEXCEPT_MAYBE
Definition Plane.hh:722

◆ load_box() [2/2]

bool load_box ( uint16_t  styles,
uint64_t  channels,
Cell ul,
Cell ur,
Cell ll,
Cell lr,
Cell hl,
Cell vl,
const char gclusters 
) const
inline

Definition at line 722 of file Plane.hh.

723 {
724 return error_guard (nccells_load_box (plane, styles, channels, ul, ur, ll, lr, hl, vl, gclusters), -1);
725 }

◆ load_double_box() [1/2]

bool load_double_box ( CellStyle  style,
uint64_t  channels,
Cell ul,
Cell ur,
Cell ll,
Cell lr,
Cell hl,
Cell vl 
) const
inline

Definition at line 747 of file Plane.hh.

748 {
749 return load_double_box (static_cast<uint16_t>(style), channels, ul, ur, ll, lr, hl, vl);
750 }
bool load_double_box(uint16_t styles, uint64_t channels, Cell &ul, Cell &ur, Cell &ll, Cell &lr, Cell &hl, Cell &vl) const NOEXCEPT_MAYBE
Definition Plane.hh:742

◆ load_double_box() [2/2]

bool load_double_box ( uint16_t  styles,
uint64_t  channels,
Cell ul,
Cell ur,
Cell ll,
Cell lr,
Cell hl,
Cell vl 
) const
inline

Definition at line 742 of file Plane.hh.

743 {
744 return error_guard (nccells_double_box (plane, styles, channels, ul, ur, ll, lr, hl, vl), -1);
745 }

◆ load_egc32()

int load_egc32 ( Cell cell,
uint32_t  egc 
) const
inline

Definition at line 1058 of file Plane.hh.

1059 {
1060 int ret = nccell_load_egc32 (plane, cell, egc);
1061 return error_guard_cond<int> (ret, ret != 1);
1062 }

◆ load_rounded_box() [1/2]

bool load_rounded_box ( CellStyle  style,
uint64_t  channels,
Cell ul,
Cell ur,
Cell ll,
Cell lr,
Cell hl,
Cell vl 
) const
inline

Definition at line 737 of file Plane.hh.

738 {
739 return load_rounded_box (static_cast<uint16_t>(style), channels, ul, ur, ll, lr, hl, vl);
740 }
bool load_rounded_box(uint16_t styles, uint64_t channels, Cell &ul, Cell &ur, Cell &ll, Cell &lr, Cell &hl, Cell &vl) const NOEXCEPT_MAYBE
Definition Plane.hh:732

◆ load_rounded_box() [2/2]

bool load_rounded_box ( uint16_t  styles,
uint64_t  channels,
Cell ul,
Cell ur,
Cell ll,
Cell lr,
Cell hl,
Cell vl 
) const
inline

Definition at line 732 of file Plane.hh.

733 {
734 return error_guard (nccells_rounded_box (plane, styles, channels, ul, ur, ll, lr, hl, vl), -1);
735 }

◆ map_plane()

static Plane * map_plane ( ncplane ncp,
Plane associated_plane = nullptr 
)
staticnoexcept

◆ mergedown() [1/2]

bool mergedown ( Plane dst,
unsigned  begsrcy,
unsigned  begsrcx,
unsigned  leny,
unsigned  lenx,
unsigned  dsty,
unsigned  dstx 
) const
inline

Definition at line 445 of file Plane.hh.

446 {
447 return mergedown (&dst, begsrcy, begsrcx, leny, lenx, dsty, dstx);
448 }
bool mergedown(Plane &dst, unsigned begsrcy, unsigned begsrcx, unsigned leny, unsigned lenx, unsigned dsty, unsigned dstx) const
Definition Plane.hh:445

◆ mergedown() [2/2]

bool mergedown ( Plane dst,
int  begsrcy,
int  begsrcx,
unsigned  leny,
unsigned  lenx,
int  dsty,
int  dstx 
) const
inline

Definition at line 450 of file Plane.hh.

451 {
452 if (plane == dst->plane)
453 throw invalid_argument ("'dst' must refer to a different plane than the one this method is called on");
454
455 return error_guard (ncplane_mergedown (plane, dst->plane, begsrcy, begsrcx, leny, lenx, dsty, dstx), -1);
456 }
int ncplane_mergedown(ncplane *restrict src, ncplane *restrict dst, int begsrcy, int begsrcx, unsigned leny, unsigned lenx, int dsty, int dstx)
Definition render.c:514
Here is the call graph for this function:

◆ mergedown_simple() [1/2]

bool mergedown_simple ( Plane dst) const
inline

Definition at line 458 of file Plane.hh.

459 {
460 return mergedown_simple (&dst);
461 }
bool mergedown_simple(Plane &dst) const
Definition Plane.hh:458

◆ mergedown_simple() [2/2]

bool mergedown_simple ( Plane dst) const
inline

Definition at line 463 of file Plane.hh.

464 {
465 if (plane == dst->plane)
466 throw invalid_argument ("'dst' must refer to a different plane than the one this method is called on");
467
468 return error_guard (ncplane_mergedown_simple (plane, dst->plane), -1);
469 }
int ncplane_mergedown_simple(ncplane *restrict src, ncplane *restrict dst)
Definition render.c:608
Here is the call graph for this function:

◆ move()

bool move ( int  y,
int  x 
) const
inline

Definition at line 404 of file Plane.hh.

405 {
406 return error_guard (ncplane_move_yx (plane, y, x), -1);
407 }
int ncplane_move_yx(ncplane *n, int y, int x)
Definition notcurses.c:2411
Here is the call graph for this function:

◆ move_above() [1/2]

bool move_above ( Plane above) const
inline

Definition at line 432 of file Plane.hh.

433 {
434 return error_guard (ncplane_move_above (plane, above.plane), -1);
435 }
int ncplane_move_above(ncplane *restrict n, ncplane *restrict above)
Definition notcurses.c:1581
Here is the call graph for this function:

◆ move_above() [2/2]

bool move_above ( Plane above) const
inline

Definition at line 437 of file Plane.hh.

438 {
439 if (above == nullptr)
440 throw invalid_argument ("'above' must be a valid pointer");
441
442 return move_above (*above);
443 }
bool move_above(Plane &above) const NOEXCEPT_MAYBE
Definition Plane.hh:432

◆ move_below() [1/2]

bool move_below ( Plane below) const
inline

Definition at line 419 of file Plane.hh.

420 {
421 return error_guard (ncplane_move_below (plane, below.plane), -1);
422 }
int ncplane_move_below(ncplane *restrict n, ncplane *restrict below)
Definition notcurses.c:1628
Here is the call graph for this function:

◆ move_below() [2/2]

bool move_below ( Plane below) const
inline

Definition at line 424 of file Plane.hh.

425 {
426 if (below == nullptr)
427 throw invalid_argument ("'below' must be a valid pointer");
428
429 return move_below (*below);
430 }
bool move_below(Plane &below) const NOEXCEPT_MAYBE
Definition Plane.hh:419

◆ move_bottom()

void move_bottom ( )
inlinenoexcept

Definition at line 414 of file Plane.hh.

415 {
416 ncplane_move_bottom (plane);
417 }

◆ move_top()

void move_top ( )
inlinenoexcept

Definition at line 409 of file Plane.hh.

410 {
411 ncplane_move_top (plane);
412 }

◆ ncreel_create()

NcReel * ncreel_create ( const ncreel_options popts = nullptr)

◆ operator ncplane *()

operator ncplane * ( )
inlinenoexcept

Definition at line 164 of file Plane.hh.

165 {
166 return plane;
167 }

◆ operator ncplane const *()

operator ncplane const * ( ) const
inlinenoexcept

Definition at line 169 of file Plane.hh.

170 {
171 return plane;
172 }

◆ perimeter()

bool perimeter ( const Cell ul,
const Cell ur,
const Cell ll,
const Cell lr,
const Cell hline,
const Cell vline,
unsigned  ctlword 
) const
inline

Definition at line 786 of file Plane.hh.

787 {
788 return error_guard (ncplane_perimeter (plane, ul, ur, ll, lr, hline, vline, ctlword), -1);
789 }

◆ perimeter_double()

bool perimeter_double ( uint16_t  stylemask,
uint64_t  channels,
unsigned  ctlword 
) const
inline

Definition at line 796 of file Plane.hh.

797 {
798 return error_guard (ncplane_perimeter_double (plane, stylemask, channels, ctlword), -1);
799 }

◆ perimeter_rounded()

bool perimeter_rounded ( uint16_t  stylemask,
uint64_t  channels,
unsigned  ctlword 
) const
inline

Definition at line 791 of file Plane.hh.

792 {
793 return error_guard (ncplane_perimeter_rounded (plane, stylemask, channels, ctlword), -1);
794 }

◆ polyfill()

int polyfill ( int  y,
int  x,
const Cell c 
) const
inline

Definition at line 801 of file Plane.hh.

802 {
803 return error_guard<int> (ncplane_polyfill_yx (plane, y, x, c), -1);
804 }
int ncplane_polyfill_yx(ncplane *n, int ystart, int xstart, const nccell *c)
Definition fill.c:80
Here is the call graph for this function:

◆ prime()

int prime ( Cell cell,
const char gcluster,
uint16_t  styles,
uint64_t  channels 
) const
inline

Definition at line 1074 of file Plane.hh.

1075 {
1076 return error_guard<int> (nccell_prime (plane, cell, gcluster, styles, channels), -1);
1077 }

◆ printf() [1/3]

int printf ( const char format,
  ... 
) const

◆ printf() [2/3]

int printf ( int  y,
int  x,
const char format,
  ... 
) const

◆ printf() [3/3]

int printf ( int  y,
NCAlign  align,
const char format,
  ... 
) const

◆ printf_stained()

int printf_stained ( const char format,
  ... 
) const

◆ pulse()

bool pulse ( const timespec ts,
fadecb  fader,
void curry 
) const
inline

Definition at line 211 of file Plane.hh.

212 {
213 return error_guard (ncplane_pulse (plane, ts, fader, curry), -1);
214 }
int ncplane_pulse(ncplane *n, const struct timespec *ts, fadecb fader, void *curry)
Definition fade.c:301
Here is the call graph for this function:

◆ putc() [1/10]

int putc ( char  c,
bool  retain_styling = false 
) const
inline

Definition at line 522 of file Plane.hh.

523 {
524 int ret;
525 if (retain_styling) {
526 ret = ncplane_putchar_stained (plane, c);
527 } else {
528 ret = ncplane_putchar (plane, c);
529 }
530
531 return error_guard<int> (ret, -1);
532 }
int ncplane_putchar_stained(ncplane *n, char c)
Definition notcurses.c:2008
Here is the call graph for this function:

◆ putc() [2/10]

int putc ( const Cell c) const
inline

Definition at line 496 of file Plane.hh.

497 {
498 return error_guard<int> (ncplane_putc (plane, c), -1);
499 }

◆ putc() [3/10]

int putc ( const Cell c) const
inline

Definition at line 501 of file Plane.hh.

502 {
503 if (c == nullptr)
504 throw invalid_argument ("'c' must be a valid pointer");
505
506 return putc (*c);
507 }
int putc(const Cell &c) const NOEXCEPT_MAYBE
Definition Plane.hh:496

◆ putc() [4/10]

int putc ( const char gclust,
size_t sbytes = nullptr,
bool  retain_styling = false 
) const
inline

Definition at line 539 of file Plane.hh.

540 {
541 int ret;
542 if (retain_styling) {
544 } else {
545 ret = ncplane_putegc (plane, gclust, sbytes);
546 }
547
548 return error_guard<int> (ret, -1);
549 }
int ncplane_putegc_stained(ncplane *n, const char *gclust, size_t *sbytes)
Definition notcurses.c:2032
Here is the call graph for this function:

◆ putc() [5/10]

int putc ( const wchar_t gclust,
size_t sbytes = nullptr,
bool  retain_styling = false 
) const
inline

Definition at line 556 of file Plane.hh.

557 {
558 int ret;
559 if (retain_styling) {
561 } else {
562 ret = ncplane_putwegc (plane, gclust, sbytes);
563 }
564
565 return error_guard<int> (ret, -1);
566 }
int ncplane_putwegc_stained(ncplane *n, const wchar_t *gclust, size_t *sbytes)
Definition notcurses.c:2020
Here is the call graph for this function:

◆ putc() [6/10]

int putc ( int  y,
int  x,
Cell const c 
) const
inline

Definition at line 509 of file Plane.hh.

510 {
511 return error_guard<int> (ncplane_putc_yx (plane, y, x, c), -1);
512 }
int ncplane_putc_yx(ncplane *n, int y, int x, const nccell *c)
Definition notcurses.c:1980
Here is the call graph for this function:

◆ putc() [7/10]

int putc ( int  y,
int  x,
Cell const c 
) const
inline

Definition at line 514 of file Plane.hh.

515 {
516 if (c == nullptr)
517 return -1;
518
519 return putc (y, x, *c);
520 }

◆ putc() [8/10]

int putc ( int  y,
int  x,
char  c 
) const
inline

Definition at line 534 of file Plane.hh.

535 {
536 return error_guard<int> (ncplane_putchar_yx (plane, y, x, c), -1);
537 }

◆ putc() [9/10]

int putc ( int  y,
int  x,
const char gclust,
size_t sbytes = nullptr 
) const
inline

Definition at line 551 of file Plane.hh.

552 {
553 return error_guard<int> (ncplane_putegc_yx (plane, y, x, gclust, sbytes), -1);
554 }
int ncplane_putegc_yx(ncplane *n, int y, int x, const char *gclust, size_t *sbytes)
Definition notcurses.c:1995
Here is the call graph for this function:

◆ putc() [10/10]

int putc ( int  y,
int  x,
const wchar_t gclust,
size_t sbytes = nullptr 
) const
inline

Definition at line 568 of file Plane.hh.

569 {
570 return error_guard<int> (ncplane_putwegc_yx (plane, y, x, gclust, sbytes), -1);
571 }

◆ putstr() [1/6]

int putstr ( const char gclustarr) const
inline

Definition at line 591 of file Plane.hh.

592 {
593 int ret = ncplane_putstr (plane, gclustarr);
594 return error_guard_cond<int> (ret, ret < 0);
595 }

◆ putstr() [2/6]

int putstr ( const wchar_t gclustarr) const
inline

Definition at line 608 of file Plane.hh.

609 {
610 return error_guard<int> (ncplane_putwstr (plane, gclustarr), -1);
611 }

◆ putstr() [3/6]

int putstr ( int  y,
int  x,
const char gclustarr 
) const
inline

Definition at line 597 of file Plane.hh.

598 {
599 int ret = ncplane_putstr_yx (plane, y, x, gclustarr);
600 return error_guard_cond<int> (ret, ret < 0);
601 }

◆ putstr() [4/6]

int putstr ( int  y,
int  x,
const wchar_t gclustarr 
) const
inline

Definition at line 613 of file Plane.hh.

614 {
615 return error_guard<int> (ncplane_putwstr_yx (plane, y, x, gclustarr), -1);
616 }

◆ putstr() [5/6]

int putstr ( int  y,
NCAlign  atype,
const char s 
) const
inline

Definition at line 603 of file Plane.hh.

604 {
605 return error_guard<int> (ncplane_putstr_aligned (plane, y, static_cast<ncalign_e>(atype), s), -1);
606 }

◆ putstr() [6/6]

int putstr ( int  y,
NCAlign  atype,
const wchar_t gcluststyles 
) const
inline

Definition at line 618 of file Plane.hh.

619 {
620 return error_guard<int> (ncplane_putwstr_aligned (plane, y, static_cast<ncalign_e>(atype), gcluststyles), -1);
621 }

◆ putstr_stained() [1/2]

int putstr_stained ( const char s) const
inline

Definition at line 628 of file Plane.hh.

629 {
630 int ret = ncplane_putstr_stained (plane, s);
631 return error_guard_cond<int> (ret, ret < 0);
632 }

◆ putstr_stained() [2/2]

int putstr_stained ( const wchar_t gclustarr) const
inline

Definition at line 623 of file Plane.hh.

624 {
626 }
int ncplane_putwstr_stained(ncplane *n, const wchar_t *gclustarr)
Definition notcurses.c:3278
Here is the call graph for this function:

◆ putwc_stained()

int putwc_stained ( wchar_t  w) const
inline

Definition at line 586 of file Plane.hh.

587 {
588 return error_guard<int> (ncplane_putwc_stained (plane, w), -1);
589 }

◆ putwch() [1/2]

int putwch ( int  y,
int  x,
wchar_t  w 
) const
inline

Definition at line 575 of file Plane.hh.

576 {
577 return error_guard<int> (ncplane_putwc_yx (plane, y, x, w), -1);
578 }

◆ putwch() [2/2]

int putwch ( wchar_t  w) const
inline

Definition at line 581 of file Plane.hh.

582 {
583 return error_guard<int> (ncplane_putwc (plane, w), -1);
584 }

◆ qrcode()

int qrcode ( unsigned ymax,
unsigned xmax,
const void data,
size_t  len 
) const
inline

Definition at line 1218 of file Plane.hh.

1219 {
1220 int ret = ncplane_qrcode (plane, ymax, xmax, data, len);
1221 return error_guard_cond<int> (ret, ret < 0);
1222 }
int ncplane_qrcode(ncplane *n, unsigned *ymax, unsigned *xmax, const void *data, size_t len)
Definition fill.c:651
Here is the call graph for this function:

◆ release()

void release ( Cell cell) const
inlinenoexcept

Definition at line 1079 of file Plane.hh.

1080 {
1081 nccell_release (plane, cell);
1082 }
void nccell_release(ncplane *n, nccell *c)
Definition render.c:128
Here is the call graph for this function:

◆ release_native_plane()

void release_native_plane ( )
inlineprotectednoexcept

Definition at line 1282 of file Plane.hh.

1283 {
1284 if (plane == nullptr)
1285 return;
1286
1287 unmap_plane (this);
1288 plane = nullptr;
1289 }
Here is the caller graph for this function:

◆ reparent() [1/3]

Plane * reparent ( const Plane newparent) const
inlinenoexcept

Definition at line 375 of file Plane.hh.

376 {
377 return reparent (const_cast<Plane*>(&newparent));
378 }
Plane * reparent(Plane *newparent=nullptr) const noexcept
Definition Plane.hh:361

◆ reparent() [2/3]

Plane * reparent ( const Plane newparent) const
inlinenoexcept

Definition at line 370 of file Plane.hh.

371 {
372 return reparent (const_cast<Plane*>(newparent));
373 }

◆ reparent() [3/3]

Plane * reparent ( Plane newparent = nullptr) const
inlinenoexcept

Definition at line 361 of file Plane.hh.

362 {
363 ncplane *ret = ncplane_reparent (plane, newparent == nullptr ? plane : newparent->plane);
364 if (ret == nullptr)
365 return nullptr;
366
367 return map_plane (ret);
368 }
ncplane * ncplane_reparent(ncplane *n, ncplane *newparent)
Definition notcurses.c:2791
Here is the call graph for this function:

◆ reparent_family() [1/3]

Plane * reparent_family ( const Plane newparent) const
inlinenoexcept

Definition at line 394 of file Plane.hh.

395 {
396 return reparent_family (const_cast<Plane*>(&newparent));
397 }
Plane * reparent_family(Plane *newparent=nullptr) const noexcept
Definition Plane.hh:380

◆ reparent_family() [2/3]

Plane * reparent_family ( const Plane newparent) const
inlinenoexcept

Definition at line 389 of file Plane.hh.

390 {
391 return reparent_family (const_cast<Plane*>(newparent));
392 }

◆ reparent_family() [3/3]

Plane * reparent_family ( Plane newparent = nullptr) const
inlinenoexcept

Definition at line 380 of file Plane.hh.

381 {
382 ncplane *ret = ncplane_reparent_family (plane, newparent == nullptr ? plane : newparent->plane);
383 if (ret == nullptr)
384 return nullptr;
385
386 return map_plane (ret);
387 }
ncplane * ncplane_reparent_family(ncplane *n, ncplane *newparent)
Definition notcurses.c:2913
Here is the call graph for this function:

◆ resize() [1/2]

bool resize ( int  keepy,
int  keepx,
int  keepleny,
int  keeplenx,
int  yoff,
int  xoff,
int  ylen,
int  xlen 
) const
inline

Definition at line 194 of file Plane.hh.

195 {
196 int ret = ncplane_resize (
197 plane,
198 keepy,
199 keepx,
200 keepleny,
201 keeplenx,
202 yoff,
203 xoff,
204 ylen,
205 xlen
206 );
207
208 return error_guard (ret, -1);
209 }
int ncplane_resize(ncplane *n, int keepy, int keepx, unsigned keepleny, unsigned keeplenx, int yoff, int xoff, unsigned ylen, unsigned xlen)
Definition notcurses.c:1006
Here is the call graph for this function:

◆ resize() [2/2]

bool resize ( int  ylen,
int  xlen 
) const
inline

Definition at line 231 of file Plane.hh.

232 {
233 return error_guard (ncplane_resize_simple (plane, ylen, xlen), -1);
234 }

◆ resize_maximize()

bool resize_maximize ( ) const
inline

Definition at line 184 of file Plane.hh.

185 {
186 return error_guard (ncplane_resize_maximize (plane), -1);
187 }
int ncplane_resize_maximize(ncplane *n)
Definition notcurses.c:2753
Here is the call graph for this function:

◆ resize_realign()

bool resize_realign ( ) const
inline

Definition at line 189 of file Plane.hh.

190 {
191 return error_guard (ncplane_resize_realign (plane), -1);
192 }
int ncplane_resize_realign(ncplane *n)
Definition notcurses.c:2764
Here is the call graph for this function:

◆ rgba()

uint32_t * rgba ( ncblitter_e  blit,
unsigned  begy,
unsigned  begx,
unsigned  leny,
unsigned  lenx 
) const
inlinenoexcept

Definition at line 806 of file Plane.hh.

807 {
808 return ncplane_as_rgba (plane, blit, begy, begx, leny, lenx, nullptr, nullptr);
809 }
uint32_t * ncplane_as_rgba(const ncplane *nc, ncblitter_e blit, int begy, int begx, unsigned leny, unsigned lenx, unsigned *pxdimy, unsigned *pxdimx)
Definition notcurses.c:3214
Here is the call graph for this function:

◆ rotate_ccw()

bool rotate_ccw ( ) const
inlinenoexcept

Definition at line 1179 of file Plane.hh.

1180 {
1181 return error_guard (ncplane_rotate_ccw (plane), -1);
1182 }
int ncplane_rotate_ccw(ncplane *n)
Definition fill.c:515
Here is the call graph for this function:

◆ rotate_cw()

bool rotate_cw ( ) const
inline

Definition at line 1174 of file Plane.hh.

1175 {
1176 return error_guard (ncplane_rotate_cw (plane), -1);
1177 }
int ncplane_rotate_cw(ncplane *n)
Definition fill.c:484
Here is the call graph for this function:

◆ rounded_box()

bool rounded_box ( uint16_t  styles,
uint64_t  channels,
int  ystop,
int  xstop,
unsigned  ctlword 
) const
inline

Definition at line 766 of file Plane.hh.

767 {
768 return error_guard (ncplane_rounded_box (plane, styles, channels, ystop, xstop, ctlword), -1);
769 }

◆ rounded_box_sized()

bool rounded_box_sized ( uint16_t  styles,
uint64_t  channels,
int  ylen,
int  xlen,
unsigned  ctlword 
) const
inline

Definition at line 771 of file Plane.hh.

772 {
773 return error_guard (ncplane_rounded_box_sized (plane, styles, channels, ylen, xlen, ctlword), -1);
774 }

◆ set_base()

bool set_base ( const char egc,
uint16_t  stylemask,
uint64_t  channels 
) const
inline

Definition at line 977 of file Plane.hh.

978 {
979 bool ret = ncplane_set_base (plane, egc, stylemask, channels) < 0;
981 }
int ncplane_set_base(ncplane *ncp, const char *egc, uint16_t stylemask, uint64_t channels)
Definition notcurses.c:1565
Here is the call graph for this function:

◆ set_base_cell()

bool set_base_cell ( Cell c) const
inline

Definition at line 971 of file Plane.hh.

972 {
973 bool ret = ncplane_set_base_cell (plane, c) < 0;
975 }
int ncplane_set_base_cell(ncplane *ncp, const nccell *c)
Definition notcurses.c:1558
Here is the call graph for this function:

◆ set_bg_alpha()

bool set_bg_alpha ( unsigned  alpha) const
inline

Definition at line 861 of file Plane.hh.

862 {
863 return error_guard (ncplane_set_bg_alpha (plane, alpha), -1);
864 }
int ncplane_set_bg_alpha(ncplane *n, int alpha)
Definition notcurses.c:1546
Here is the call graph for this function:

◆ set_bg_default()

void set_bg_default ( ) const
inlinenoexcept

Definition at line 921 of file Plane.hh.

922 {
924 }
void ncplane_set_bg_default(ncplane *n)
Definition notcurses.c:1506
Here is the call graph for this function:

◆ set_bg_palindex()

bool set_bg_palindex ( int  idx) const
inline

Definition at line 911 of file Plane.hh.

912 {
913 return error_guard (ncplane_set_bg_alpha (plane, idx), -1);
914 }
uint32_t idx
Definition egcpool.h:298
Here is the call graph for this function:

◆ set_bg_rgb()

bool set_bg_rgb ( uint32_t  channel) const
inline

Definition at line 916 of file Plane.hh.

917 {
918 return error_guard (ncplane_set_bg_rgb (plane, channel), -1);
919 }
int ncplane_set_bg_rgb(ncplane *n, unsigned channel)
Definition notcurses.c:1538
Here is the call graph for this function:

◆ set_bg_rgb8()

bool set_bg_rgb8 ( int  r,
int  g,
int  b,
bool  clipped = false 
) const
inline

Definition at line 901 of file Plane.hh.

902 {
903 if (clipped) {
904 ncplane_set_bg_rgb8_clipped (plane, r, g, b);
905 return true;
906 }
907
908 return error_guard (ncplane_set_bg_rgb8 (plane, r, g, b), -1);
909 }
void ncplane_set_bg_rgb8_clipped(ncplane *n, int r, int g, int b)
Definition notcurses.c:1510
int ncplane_set_bg_rgb8(ncplane *n, unsigned r, unsigned g, unsigned b)
Definition notcurses.c:1514
Here is the call graph for this function:

◆ set_channels()

void set_channels ( uint64_t  channels) const
inlinenoexcept

Definition at line 846 of file Plane.hh.

847 {
848 ncplane_set_channels (plane, channels);
849 }
void ncplane_set_channels(ncplane *n, uint64_t channels)
Definition notcurses.c:1494
Here is the call graph for this function:

◆ set_fg_alpha()

bool set_fg_alpha ( unsigned  alpha) const
inline

Definition at line 851 of file Plane.hh.

852 {
853 return error_guard (ncplane_set_fg_alpha (plane, alpha), -1);
854 }
int ncplane_set_fg_alpha(ncplane *n, int alpha)
Definition notcurses.c:1542
Here is the call graph for this function:

◆ set_fg_default()

void set_fg_default ( ) const
inlinenoexcept

Definition at line 891 of file Plane.hh.

892 {
894 }
void ncplane_set_fg_default(ncplane *n)
Definition notcurses.c:1502
Here is the call graph for this function:

◆ set_fg_palindex()

bool set_fg_palindex ( int  idx) const
inline

Definition at line 881 of file Plane.hh.

882 {
883 return error_guard (ncplane_set_fg_palindex (plane, idx), -1);
884 }
int ncplane_set_fg_palindex(ncplane *n, unsigned idx)
Definition notcurses.c:1550
Here is the call graph for this function:

◆ set_fg_rgb()

bool set_fg_rgb ( uint32_t  channel) const
inline

Definition at line 886 of file Plane.hh.

887 {
888 return error_guard (ncplane_set_fg_rgb (plane, channel), -1);
889 }
int ncplane_set_fg_rgb(ncplane *n, unsigned channel)
Definition notcurses.c:1526
Here is the call graph for this function:

◆ set_fg_rgb8()

bool set_fg_rgb8 ( int  r,
int  g,
int  b,
bool  clipped = false 
) const
inline

Definition at line 871 of file Plane.hh.

872 {
873 if (clipped) {
874 ncplane_set_fg_rgb8_clipped (plane, r, g, b);
875 return true;
876 }
877
878 return error_guard (ncplane_set_fg_rgb8 (plane, r, g, b), -1);
879 }
void ncplane_set_fg_rgb8_clipped(ncplane *n, int r, int g, int b)
Definition notcurses.c:1518
int ncplane_set_fg_rgb8(ncplane *n, unsigned r, unsigned g, unsigned b)
Definition notcurses.c:1522
Here is the call graph for this function:

◆ set_plane()

void set_plane ( ncplane _plane)
inlineprotected

Definition at line 1268 of file Plane.hh.

1269 {
1270 if (_plane == nullptr) {
1271 throw invalid_argument ("_plane must be a valid pointer");
1272 }
1273
1274 if (plane != nullptr) {
1275 throw invalid_state_error ("Plane::set_plane can be called only once");
1276 }
1277
1278 plane = _plane;
1279 map_plane (plane, this);
1280 }

◆ set_resizecb()

void set_resizecb ( int(*)(struct ncplane *)  resizecb) const
inlinenoexcept

Definition at line 1244 of file Plane.hh.

1245 {
1246 ncplane_set_resizecb (plane, resizecb);
1247 }
void ncplane_set_resizecb(ncplane *n, int(*resizecb)(ncplane *))
Definition notcurses.c:2673
Here is the call graph for this function:

◆ set_scrolling()

bool set_scrolling ( bool  scrollp) const
inlinenoexcept

Definition at line 926 of file Plane.hh.

927 {
928 return ncplane_set_scrolling (plane, scrollp);
929 }
bool ncplane_set_scrolling(ncplane *n, unsigned scrollp)
Definition notcurses.c:2993
Here is the call graph for this function:

◆ set_userptr() [1/2]

template<typename T >
T * set_userptr ( T opaque) const
inlinenoexcept

Definition at line 1037 of file Plane.hh.

1038 {
1039 return static_cast<T*>(set_userptr (static_cast<void*>(opaque)));
1040 }
void * set_userptr(void *opaque) const noexcept
Definition Plane.hh:1031

◆ set_userptr() [2/2]

void * set_userptr ( void opaque) const
inlinenoexcept

Definition at line 1031 of file Plane.hh.

1032 {
1033 return ncplane_set_userptr (plane, opaque);
1034 }
void * ncplane_set_userptr(ncplane *n, void *opaque)
Definition notcurses.c:186
Here is the call graph for this function:

◆ stain()

int stain ( int  y,
int  x,
unsigned  ylen,
unsigned  xlen,
uint64_t  ul,
uint64_t  ur,
uint64_t  ll,
uint64_t  lr 
) const
inline

Definition at line 956 of file Plane.hh.

957 {
958 return error_guard<int> (ncplane_stain (plane, y, x, ylen, xlen, ul, ur, ll, lr), -1);
959 }
int ncplane_stain(ncplane *n, int y, int x, unsigned ylen, unsigned xlen, uint64_t tl, uint64_t tr, uint64_t bl, uint64_t br)
Definition fill.c:272
Here is the call graph for this function:

◆ strdup()

char * strdup ( Cell const cell) const
inlinenoexcept

Definition at line 1184 of file Plane.hh.

1185 {
1186 return nccell_strdup (plane, cell);
1187 }

◆ styles_off()

void styles_off ( CellStyle  styles) const
inlinenoexcept

Definition at line 946 of file Plane.hh.

947 {
948 ncplane_off_styles (plane, static_cast<unsigned>(styles));
949 }
void ncplane_off_styles(ncplane *n, unsigned stylebits)
Definition notcurses.c:2081
Here is the call graph for this function:

◆ styles_on()

void styles_on ( CellStyle  styles) const
inlinenoexcept

Definition at line 941 of file Plane.hh.

942 {
943 ncplane_on_styles (plane, static_cast<unsigned>(styles));
944 }
void ncplane_on_styles(ncplane *n, unsigned stylebits)
Definition notcurses.c:2076
Here is the call graph for this function:

◆ styles_set()

void styles_set ( CellStyle  styles) const
inlinenoexcept

Definition at line 936 of file Plane.hh.

937 {
938 ncplane_set_styles (plane, static_cast<unsigned>(styles));
939 }
void ncplane_set_styles(ncplane *n, unsigned stylebits)
Definition notcurses.c:2071
Here is the call graph for this function:

◆ to_ncplane()

ncplane * to_ncplane ( ) const
inlinenoexcept

Definition at line 179 of file Plane.hh.

180 {
181 return plane;
182 }

◆ translate() [1/4]

void translate ( const Plane dst,
int y = nullptr,
int x = nullptr 
) const
inlinenoexcept

Definition at line 1151 of file Plane.hh.

1152 {
1153 translate (*this, dst, y, x);
1154 }
void translate(const Plane *dst, int *y=nullptr, int *x=nullptr) const noexcept
Definition Plane.hh:1146

◆ translate() [2/4]

static void translate ( const Plane src,
const Plane dst,
int y = nullptr,
int x = nullptr 
)
inlinestaticnoexcept

Definition at line 1164 of file Plane.hh.

1165 {
1166 ncplane_translate (src.plane, dst.plane, y, x);
1167 }
void ncplane_translate(const ncplane *src, const ncplane *dst, int *restrict y, int *restrict x)
Definition notcurses.c:2613
Here is the call graph for this function:

◆ translate() [3/4]

void translate ( const Plane dst,
int y = nullptr,
int x = nullptr 
) const
inlinenoexcept

Definition at line 1146 of file Plane.hh.

1147 {
1148 ncplane_translate (*this, dst ? dst->plane: nullptr, y, x);
1149 }
Here is the call graph for this function:

◆ translate() [4/4]

static void translate ( const Plane src,
const Plane dst,
int y = nullptr,
int x = nullptr 
)
inlinestatic

Definition at line 1156 of file Plane.hh.

1157 {
1158 if (src == nullptr)
1159 throw invalid_argument ("'src' must be a valid pointer");
1160
1161 ncplane_translate (*src, dst ? dst->plane : nullptr, y, x);
1162 }
Here is the call graph for this function:

◆ translate_abs()

bool translate_abs ( int y = nullptr,
int x = nullptr 
) const
inline

Definition at line 1169 of file Plane.hh.

1170 {
1171 return error_guard<bool, bool> (ncplane_translate_abs (plane, y, x), false);
1172 }
bool ncplane_translate_abs(const ncplane *n, int *restrict y, int *restrict x)
Definition notcurses.c:2590
Here is the call graph for this function:

◆ unmap_plane()

static void unmap_plane ( Plane p)
staticprotectednoexcept

◆ va_end() [1/4]

va_end ( va  )

◆ va_end() [2/4]

va_end ( va  )

◆ va_end() [3/4]

va_end ( va  )

◆ va_end() [4/4]

va_end ( va  )

◆ va_start() [1/4]

int va_start ( va  ,
format   
)

◆ va_start() [2/4]

int va_start ( va  ,
format   
)

◆ va_start() [3/4]

int va_start ( va  ,
format   
)

◆ va_start() [4/4]

int va_start ( va  ,
format   
)

◆ vline() [1/2]

int vline ( const Cell c,
unsigned  len 
) const
inline

Definition at line 712 of file Plane.hh.

713 {
714 return error_guard<int> (ncplane_vline (plane, c, len), -1);
715 }

◆ vline() [2/2]

int vline ( const Cell c,
unsigned  len,
uint64_t  c1,
uint64_t  c2 
) const
inline

Definition at line 717 of file Plane.hh.

718 {
719 return error_guard<int> (ncplane_vline_interp (plane, c, len, c1, c2), -1);
720 }
int ncplane_vline_interp(ncplane *n, const nccell *c, unsigned len, uint64_t c1, uint64_t c2)
Definition notcurses.c:2209
Here is the call graph for this function:

◆ vprintf() [1/3]

int vprintf ( const char format,
va_list  ap 
) const
inline

Definition at line 687 of file Plane.hh.

688 {
689 return error_guard<int> (ncplane_vprintf (plane, format, ap), -1);
690 }
int format(int y, int x, unsigned ylen, unsigned xlen, uint16_t stylemask) const NOEXCEPT_MAYBE
Definition Plane.hh:951

◆ vprintf() [2/3]

int vprintf ( int  y,
int  x,
const char format,
va_list  ap 
) const
inline

Definition at line 692 of file Plane.hh.

693 {
694 return error_guard<int> (ncplane_vprintf_yx (plane, y, x, format, ap), -1);
695 }
int ncplane_vprintf_yx(ncplane *n, int y, int x, const char *format, va_list ap)
Definition notcurses.c:2115
Here is the call graph for this function:

◆ vprintf() [3/3]

int vprintf ( int  y,
NCAlign  align,
const char format,
va_list  ap 
) const
inline

Definition at line 697 of file Plane.hh.

698 {
699 return error_guard<int> (ncplane_vprintf_aligned (plane, y, static_cast<ncalign_e>(align), format, ap), -1);
700 }
int ncplane_vprintf_aligned(ncplane *n, int y, ncalign_e align, const char *format, va_list ap)
Definition notcurses.c:2125
Here is the call graph for this function:

◆ vprintf_stained()

int vprintf_stained ( const char format,
va_list  ap 
) const
inline

Definition at line 682 of file Plane.hh.

683 {
684 return error_guard<int> (ncplane_vprintf_stained (plane, format, ap), -1);
685 }
int ncplane_vprintf_stained(struct ncplane *n, const char *format, va_list ap)
Definition notcurses.c:2136
Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ NcReel

Definition at line 1359 of file Plane.hh.

◆ NotCurses

Definition at line 1358 of file Plane.hh.

◆ PlotBase

Definition at line 1362 of file Plane.hh.

◆ Tablet

friend class Tablet
friend

Definition at line 1360 of file Plane.hh.

◆ Widget

Definition at line 1361 of file Plane.hh.

Field Documentation

◆ ret

Definition at line 640 of file Plane.hh.


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