.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "notcurses_channels" "3" "v2.2.3" "" ""
.hy
.SH NAME
.PP
notcurses_channels - operations on notcurses channels
.SH SYNOPSIS
.PP
\f[B]#include <notcurses/notcurses.h>\f[R]
.IP
.nf
\f[C]
#define CHANNELS_RGB_INITIALIZER(fr, fg, fb, br, bg, bb) \[rs]
  (((((uint64_t)(fr) << 16u) + ((uint64_t)(fg) << 8u) + (uint64_t)(fb)) << 32ull) + \[rs]
   (((br) << 16u) + ((bg) << 8u) + (bb)) + CELL_BGDEFAULT_MASK + CELL_FGDEFAULT_MASK)

#define CHANNEL_RGB_INITIALIZER(r, g, b) \[rs]
  (((uint32_t)r << 16u) + ((uint32_t)g << 8u) + (b) + CELL_BGDEFAULT_MASK)
\f[R]
.fi
.PP
\f[B]uint32_t channel_r(uint32_t \f[R]\f[I]channel\f[R]\f[B]);\f[R]
.PP
\f[B]uint32_t channel_g(uint32_t \f[R]\f[I]channel\f[R]\f[B]);\f[R]
.PP
\f[B]uint32_t channel_b(uint32_t \f[R]\f[I]channel\f[R]\f[B]);\f[R]
.PP
\f[B]uint32_t channel_rgb8(uint32_t \f[R]\f[I]channel\f[R]\f[B],
uint32_t* restrict \f[R]\f[I]r\f[R]\f[B], uint32_t* restrict
\f[R]\f[I]g\f[R]\f[B], uint32_t* restrict \f[R]\f[I]b\f[R]\f[B]);\f[R]
.PP
\f[B]int channel_set_rgb8(uint32_t* \f[R]\f[I]channel\f[R]\f[B], int
\f[R]\f[I]r\f[R]\f[B], int \f[R]\f[I]g\f[R]\f[B], int
\f[R]\f[I]b\f[R]\f[B]);\f[R]
.PP
\f[B]int channel_set(uint32_t* \f[R]\f[I]channel\f[R]\f[B], uint32_t
\f[R]\f[I]rgb\f[R]\f[B]);\f[R]
.PP
\f[B]unsigned channel_palindex(uint32_t
\f[R]\f[I]channel\f[R]\f[B]);\f[R]
.PP
\f[B]int channel_set_palindex(uint32_t* \f[R]\f[I]channel\f[R]\f[B], int
\f[R]\f[I]idx\f[R]\f[B]);\f[R]
.PP
\f[B]uint32_t channel_alpha(uint32_t \f[R]\f[I]channel\f[R]\f[B]);\f[R]
.PP
\f[B]int channel_set_alpha(uint32_t* \f[R]\f[I]channel\f[R]\f[B],
unsigned \f[R]\f[I]alpha\f[R]\f[B]);\f[R]
.PP
\f[B]bool channel_default_p(uint32_t \f[R]\f[I]channel\f[R]\f[B]);\f[R]
.PP
\f[B]uint32_t channel_set_default(uint32_t*
\f[R]\f[I]channel\f[R]\f[B]);\f[R]
.PP
\f[B]unsigned channels_fg_rgb(uint64_t
\f[R]\f[I]channels\f[R]\f[B]);\f[R]
.PP
\f[B]unsigned channels_bg_rgb(uint64_t
\f[R]\f[I]channels\f[R]\f[B]);\f[R]
.PP
\f[B]int channels_set_fg_rgb(uint64_t* \f[R]\f[I]channels\f[R]\f[B],
unsigned \f[R]\f[I]rgb\f[R]\f[B]);\f[R]
.PP
\f[B]int channels_set_bg_rgb(uint64_t* \f[R]\f[I]channels\f[R]\f[B],
unsigned \f[R]\f[I]rgb\f[R]\f[B]);\f[R]
.PP
\f[B]unsigned channels_fg_alpha(uint64_t
\f[R]\f[I]channels\f[R]\f[B]);\f[R]
.PP
\f[B]unsigned channels_bg_alpha(uint64_t
\f[R]\f[I]channels\f[R]\f[B]);\f[R]
.PP
\f[B]int channels_set_fg_alpha(uint64_t* \f[R]\f[I]channels\f[R]\f[B],
int \f[R]\f[I]alpha\f[R]\f[B]);\f[R]
.PP
\f[B]int channels_set_bg_alpha(uint64_t* \f[R]\f[I]channels\f[R]\f[B],
int \f[R]\f[I]alpha\f[R]\f[B]);\f[R]
.PP
\f[B]unsigned channels_fg_palindex(uint64_t
\f[R]\f[I]channels\f[R]\f[B]);\f[R]
.PP
\f[B]unsigned channels_bg_palindex(uint64_t
\f[R]\f[I]channels\f[R]\f[B]);\f[R]
.PP
\f[B]int channels_set_fg_palindex(uint64_t*
\f[R]\f[I]channels\f[R]\f[B], int \f[R]\f[I]idx\f[R]\f[B]);\f[R]
.PP
\f[B]int channels_set_bg_palindex(uint64_t*
\f[R]\f[I]channels\f[R]\f[B], int \f[R]\f[I]idx\f[R]\f[B]);\f[R]
.PP
\f[B]unsigned channels_fg_rgb8(uint64_t \f[R]\f[I]channels\f[R]\f[B],
unsigned* \f[R]\f[I]r\f[R]\f[B], unsigned* \f[R]\f[I]g\f[R]\f[B],
unsigned* \f[R]\f[I]b\f[R]\f[B]);\f[R]
.PP
\f[B]unsigned channels_bg_rgb8(uint64_t \f[R]\f[I]channels\f[R]\f[B],
unsigned* \f[R]\f[I]r\f[R]\f[B], unsigned* \f[R]\f[I]g\f[R]\f[B],
unsigned* \f[R]\f[I]b\f[R]\f[B]);\f[R]
.PP
\f[B]int channels_set_fg_rgb8(uint64_t* \f[R]\f[I]channels\f[R]\f[B],
int \f[R]\f[I]r\f[R]\f[B], int \f[R]\f[I]g\f[R]\f[B], int
\f[R]\f[I]b\f[R]\f[B]);\f[R]
.PP
\f[B]int channels_set_bg_rgb8(uint64_t* \f[R]\f[I]channels\f[R]\f[B],
int \f[R]\f[I]r\f[R]\f[B], int \f[R]\f[I]g\f[R]\f[B], int
\f[R]\f[I]b\f[R]\f[B]);\f[R]
.PP
\f[B]bool channels_fg_default_p(uint64_t
\f[R]\f[I]channels\f[R]\f[B]);\f[R]
.PP
\f[B]bool channels_bg_default_p(uint64_t
\f[R]\f[I]channels\f[R]\f[B]);\f[R]
.PP
\f[B]uint64_t channels_set_fg_default(uint64_t*
\f[R]\f[I]channels\f[R]\f[B]);\f[R]
.PP
\f[B]uint64_t channels_set_bg_default(uint64_t*
\f[R]\f[I]channels\f[R]\f[B]);\f[R]
.SH DESCRIPTION
.SH RETURN VALUES
.PP
Functions returning \f[C]int\f[R] return -1 on failure, or 0 on success.
Failure is always due to invalid inputs.
Functions returning \f[C]bool\f[R] are predicates, and return the
requested value.
Functions returning \f[C]unsigned\f[R] forms return the input, modified
as requested.
.SH SEE ALSO
.PP
\f[B]notcurses(3)\f[R], \f[B]notcurses_cell(3)\f[R],
\f[B]notcurses_plane(3)\f[R], \f[B]notcurses_output(3)\f[R]
.SH AUTHORS
nick black <nickblack@linux.com>.