notcurses_palette(3)

📦
version 3.0.17 · 8 versions
, in alpine 3.24, ubuntu resolute, ubuntu stonking

💖 NAME — notcurses_palette(3) 💖

okay so bestie, this is the manual page for notcurses_palette, and it is literally all about operations on notcurses palettes. 🎨✨

✨ SYNOPSIS ✨

here’s the exact cast of characters, no cap, zero typos:

       #include <notcurses/notcurses.h>

              typedef struct ncpalette {
                // We store the RGB values as a regular ol' channel
                uint32_t chans[NCPALETTESIZE];
              } ncpalette;

       bool notcurses_cantruecolor(const struct notcurses* nc);

       ncpalette* ncpalette_new(struct notcurses* nc);

       int ncpalette_use(struct notcurses* nc, const ncpalette* p);

       int ncpalette_set_rgb8(ncpalette* p, int idx, int r, int g, int b);

       int ncpalette_set(ncpalette* p, int idx, unsigned rgb);

       int ncpalette_get(const ncpalette* p, int idx, uint32_t* palent);

       int ncpalette_get_rgb8(const ncpalette* p, int idx, int* restrict r,
       int* restrict g, int* restrict b);

       void ncpalette_free(ncpalette* p);

       bool notcurses_canchangecolors(const struct notcurses* nc);

🦋 DESCRIPTION 🦋

some terminals are out here like “bestie I only do 256 colors,” but they still let you specify the full palette with arbitrary RGB colors. iconic behavior. 💅

in all cases, though, it is more performant to use indexed colors, because that is much less data to write to the terminal. so if you can limit yourself to 256 colors, that’s probably for the best. fr fr. 🌸

plus, palette-based color allows for very fast color cycling effects, because a single command can affect many cells on the screen at once. the way that’s so main character energy. 🌈👑

⭐ RETURN VALUES ⭐

  • functions returning int return -1 on failure, or 0 on success. failure is always due to invalid inputs. 🫶
  • functions returning bool are predicates, and they return the requested value. ✅
  • functions returning unsigned forms return the input, modified as requested. 🔁

🎀 SEE ALSO 🎀

👑 AUTHORS 👑

nick black — nickblack@linux.com 💌

that’s the whole vibe, bestie. this lil page is from the notcurses_palette(3) manual and is rockin’ version v3.0.17. 💖✨🦋

📦 where this page comes from