blackbeard420/notcurses
1
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses synced 2025-03-09 17:19:03 -04:00
Code Issues Projects Releases Wiki Activity

document ncplane_set_[fb]channel

Browse Source
This commit is contained in:
nick black 2022-01-23 21:24:07 -05:00
parent 7c4c3040f4
commit cb7e77eab2
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
3 changed files with 37 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
USAGE.md
View File

@ -1803,10 +1803,17 @@ Helpers are provided to manipulate an `ncplane`'s `channels` member. They are
all implemented in terms of the lower-level [Channels API](#channels). all implemented in terms of the lower-level [Channels API](#channels).
```c ```c
// Get the current channels or attribute word for ncplane 'n'. // Get the current colors and alpha values for ncplane 'n'.
uint64_t ncplane_channels(const struct ncplane* n); uint64_t ncplane_channels(const struct ncplane* n);
// Get the current styling for the ncplane 'n'.
uint16_t ncplane_attr(const struct ncplane* n); uint16_t ncplane_attr(const struct ncplane* n);
// Set the alpha and coloring bits of the plane's current channels from a
// 64-bit pair of channels.
API void ncplane_set_channels(struct ncplane* n, uint64_t channels)
__attribute__ ((nonnull (1)));
// Extract the background alpha and coloring bits from a 64-bit channel // Extract the background alpha and coloring bits from a 64-bit channel
// pair as a single 32-bit value. // pair as a single 32-bit value.
static inline uint32_t static inline uint32_t
@ -1821,6 +1828,15 @@ ncplane_fchannel(const struct ncplane* n){
return ncchannels_fchannel(ncplane_channels(n)); return ncchannels_fchannel(ncplane_channels(n));
} }
// Set the background alpha and coloring bits of the plane's current
// channels from a single 32-bit value.
uint64_t ncplane_set_bchannel(struct ncplane* n, uint32_t channel);
__attribute__ ((nonnull (1)));
// Set the foreground alpha and coloring bits of the plane's current
// channels from a single 32-bit value.
uint64_t ncplane_set_fchannel(struct ncplane* n, uint32_t channel);
// Extract 24 bits of working foreground RGB from an ncplane, shifted to LSBs. // Extract 24 bits of working foreground RGB from an ncplane, shifted to LSBs.
static inline unsigned static inline unsigned
ncplane_fg_rgb(const struct ncplane* nc){ ncplane_fg_rgb(const struct ncplane* nc){

4
doc/man/man3/notcurses_plane.3.md
View File

@ -151,6 +151,10 @@ typedef struct ncplane_options {
**static inline unsigned ncplane_fchannel(struct ncplane* ***nc***);** **static inline unsigned ncplane_fchannel(struct ncplane* ***nc***);**
**uint64_t ncplane_set_bchannel(struct ncplane* ***nc***, uint32_t ***channel***);**
**uint64_t ncplane_set_fchannel(struct ncplane* ***nc***, uint32_t ***channel***);**
**static inline unsigned ncplane_fg_rgb(struct ncplane* ***nc***);** **static inline unsigned ncplane_fg_rgb(struct ncplane* ***nc***);**
**static inline unsigned ncplane_bg_rgb(struct ncplane* ***nc***);** **static inline unsigned ncplane_bg_rgb(struct ncplane* ***nc***);**

24
include/notcurses/notcurses.h
View File

@ -2117,11 +2117,11 @@ ncplane_cursor_x(const struct ncplane* n){
return x; return x;
} }
// Get the current channels or attribute word for ncplane 'n'. // Get the current colors and alpha values for ncplane 'n'.
API uint64_t ncplane_channels(const struct ncplane* n) API uint64_t ncplane_channels(const struct ncplane* n)
__attribute__ ((nonnull (1))); __attribute__ ((nonnull (1)));
// Return the current styling for this ncplane. // Get the current styling for the ncplane 'n'.
API uint16_t ncplane_styles(const struct ncplane* n) API uint16_t ncplane_styles(const struct ncplane* n)
__attribute__ ((nonnull (1))); __attribute__ ((nonnull (1)));
@ -2880,25 +2880,33 @@ ncplane_fchannel(const struct ncplane* n){
return ncchannels_fchannel(ncplane_channels(n)); return ncchannels_fchannel(ncplane_channels(n));
} }
API void ncplane_set_channels(struct ncplane* n, uint64_t channels); // Set the alpha and coloring bits of the plane's current channels from a
// 64-bit pair of channels.
API void ncplane_set_channels(struct ncplane* n, uint64_t channels)
__attribute__ ((nonnull (1)));
// Set the background alpha and coloring bits of the plane's current // Set the background alpha and coloring bits of the plane's current
// channels from a single 32-bit value. // channels from a single 32-bit value.
API uint64_t ncplane_set_bchannel(struct ncplane* n, uint32_t channel); API uint64_t ncplane_set_bchannel(struct ncplane* n, uint32_t channel)
__attribute__ ((nonnull (1)));
// Set the foreground alpha and coloring bits of the plane's current // Set the foreground alpha and coloring bits of the plane's current
// channels from a single 32-bit value. // channels from a single 32-bit value.
API uint64_t ncplane_set_fchannel(struct ncplane* n, uint32_t channel); API uint64_t ncplane_set_fchannel(struct ncplane* n, uint32_t channel)
__attribute__ ((nonnull (1)));
// Set the specified style bits for the ncplane 'n', whether they're actively // Set the specified style bits for the ncplane 'n', whether they're actively
// supported or not. // supported or not.
API void ncplane_set_styles(struct ncplane* n, unsigned stylebits); API void ncplane_set_styles(struct ncplane* n, unsigned stylebits)
__attribute__ ((nonnull (1)));
// Add the specified styles to the ncplane's existing spec. // Add the specified styles to the ncplane's existing spec.
API void ncplane_on_styles(struct ncplane* n, unsigned stylebits); API void ncplane_on_styles(struct ncplane* n, unsigned stylebits)
__attribute__ ((nonnull (1)));
// Remove the specified styles from the ncplane's existing spec. // Remove the specified styles from the ncplane's existing spec.
API void ncplane_off_styles(struct ncplane* n, unsigned stylebits); API void ncplane_off_styles(struct ncplane* n, unsigned stylebits)
__attribute__ ((nonnull (1)));
// Extract 24 bits of working foreground RGB from an ncplane, shifted to LSBs. // Extract 24 bits of working foreground RGB from an ncplane, shifted to LSBs.
static inline uint32_t static inline uint32_t