TICKIT_PEN_HAS_COLOUR_ATTR_RGB8(3)

💖 tickit_pen_get_colour_attr_rgb8 — Library Functions Manual ✨

okay bestie, gather round, because we're about to talk about secondary RGB8 colour attributes on a pen and honestly? it's giving niche-but-important 💅

🌸 NAME 🌸

tickit_pen_get_colour_attr_rgb8, tickit_pen_set_colour_attr_rgb8, tickit_pen_has_attr_rgb8 — the trio that lets you manipulate a secondary RGB8 colour pen colour attribute 🎀

🦋 SYNOPSIS 🦋

#include <tickit.h>

typedef struct {
    uint8_t r;
    uint8_t g;
    uint8_t b;
} TickitPenRGB8;

TickitPenRGB8 tickit_pen_get_colour_attr_rgb8(const TickitPen *pen,
    TickitPenAttr attr);
void tickit_pen_set_colour_attr_rgb8(TickitPen *pen,
    TickitPenAttr attr, TickitPenRGB8 value);

bool tickit_pen_has_attr_rgb8(const TickitPen *pen,
    TickitPenAttr attr);

and don't forget, when you link:

Link with -ltickit.

👑 DESCRIPTION 👑

tickit_pen_get_colour_attr_rgb8() hands you back the current secondary RGB8 value of whatever colour attribute you asked for. but listen — if the attribute isn't defined, or it doesn't have a secondary RGB8 value? the return value is not specified. so like, don't be surprised, it's undefined bestie 😭

tickit_pen_set_colour_attr_rgb8() gives the given colour attribute on the pen a brand new secondary RGB8 value. huge. BUT 💀 it will only be stored if the pen already has a (primary) index value set for the corresponding attribute. that's the rule, no exceptions. and if it does successfully store the value, it invokes the TICKIT_EV_CHANGE event on the pen instance. slay 🔥

tickit_pen_has_colour_attr_rgb8() returns true if the pen instance currently stores a secondary RGB8 value for the given colour attribute. simple as that 🫶

💀 NOTES 💀

real talk: a pen instance will only store a secondary RGB8 value if a primary index value is already set. and on top of that? calling tickit_pen_set_colour_attr(3) will clear an associated secondary RGB8 value. poof, gone 🙈

the whole design here is intentional — it aims to encourage that any use of an RGB8 colour also has an index as well, so that it supports the majority of terminals which do not in fact understand RGB8 values. iconic, honestly.

so if your application wants to make use of these values, the recommendation is: set both at the same time, in sequence. like this:

tickit_pen_set_colour_attr(pen, index);
tickit_pen_set_colour_attr_rgb8(pen,
    (TickitPenRGB8){.r = red, .g = green, .b = blue});

⭐ RETURN VALUE ⭐

• tickit_pen_get_colour_attr_rgb8() — returns a three-field colour value structure 🌈
• tickit_pen_set_colour_attr_rgb8() — returns no value (it's a void girlie, she just does the thing)
• tickit_pen_has_colour_attr_rgb8() — returns a boolean

🌈 SEE ALSO 🌈

• tickit_pen_new(3)
• tickit_pen_set_colour_attr(3)
• tickit_pen_clear_attr(3)
• tickit_pen(7)
• tickit(7)

and that's the whole page, bestie 💜 this was TICKIT_PEN...R_ATTR_RGB8(3) from the Library Functions Manual — go forth and set your primary index and your RGB8 together, in sequence, like the responsible main character you are 🎀✨