Hint

Refer to QMK’s documentation for details on how to use community modules

colors

Custom type to define colors in different ways.

enum color_type_t

Different ways in which a color can be specified.

enumerator COLOR_TYPE_RGB

enumerator COLOR_TYPE_HSV

enumerator COLOR_TYPE_HUE

Color of a specific hue, whose saturation and value follow RGB matrix’s settings.

enumerator COLOR_TYPE_TRNS

Transparency, used for falling back into another color.

Note

The color “below” has to be computed by other code based on context. This type of value stores no color information.

enumerator COLOR_TYPE_WHITE

White color whose brightness (val) follows RGB matrix’s settings.

struct color_t

Represent colors in different ways.

color_type_t type

How this color is specified: rgb, hsv, just hue, …

union [anonymous]

Inner value.

rgb_t rgb

hsv_t hsv

RGB_COLOR(_rgb...)

Create a color_t instance from a RGB triplet.

HSV_COLOR(_hsv...)

Create a color_t instance from a HSV triplet.

enum qmk_hues

Hue values for QMK builtin colors.

enumerator HUE_AZURE = 132

enumerator HUE_BLUE = 170

enumerator HUE_CHARTREUSE = 64

enumerator HUE_CORAL = 11

enumerator HUE_CYAN = 128

enumerator HUE_GOLD = 36

enumerator HUE_GOLDENROD = 30

enumerator HUE_GREEN = 85

enumerator HUE_MAGENTA = 213

enumerator HUE_ORANGE = 21

enumerator HUE_PINK = 234

enumerator HUE_PURPLE = 191

enumerator HUE_RED = 0

enumerator HUE_SPRINGGREEN = 106

enumerator HUE_TEAL = 128

enumerator HUE_TURQUOISE = 123

enumerator HUE_YELLOW = 43

HUE(_hue)

Create a color_t instance from a hue value.

TRNS_COLOR

Create a color_t instance for transparency.

WHITE_COLOR

Create a color_t instance for white.

int to_rgb(color_t color, rgb_t *rgb)

Convert a color_t to RGB format.

Parameters:

• color – Color definition.

• rgb – Pointer where the value will be written.

Return: Result of the operation.

• 0: Color was retrieved.

• -ENODATA: TRNS was found, there’s nothing to work with.

• -EINVAL: Invalid value (color.type is not a value in color_type_t).