`ledmap`¶

Define a static, per-key, RGB matrix design.

It works similar to keymaps, mapping a color to each key and allowing transparency.

Your configuration would end up looking like:

const ledmap_color_t PROGMEM ledmap[][MATRIX_ROWS][MATRIX_COLS] = {
    [_QWERTY] = LAYOUT(
        RED,  RED,  RED,  RED,  RED,  RED,     RED,  RED,  RED,  RED,  RED,  RED,
        RED,  RED,  RED,  RED,  RED,  RED,     RED,  RED,  RED,  RED,  RED,  RED,
        RED,  RED,  RED,  RED,  RED,  RED,     RED,  RED,  RED,  RED,  RED,  RED,
        RED,  RED,  RED,  RED,  RED,  RED,     RED,  RED,  RED,  RED,  RED,  RED,
        RED,  RED,  RED,  RED,    BLACK,         WHITE,    RED,  TRNS, RED,  RED
    ),
    [_FN] = LAYOUT(
        TRNS, TRNS, TRNS, TRNS, TRNS, TRNS,    TRNS, TRNS, TRNS, TRNS, TRNS, TRNS,
        CYAN, CYAN, CYAN, CYAN, CYAN, CYAN,    CYAN, CYAN, CYAN, CYAN, CYAN, CYAN,
        BLUE, BLUE, BLUE, BLUE, BLUE, BLUE,    BLUE, BLUE, BLUE, BLUE, BLUE, BLUE,
        ROSE, ROSE, ROSE, ROSE, ROSE, ROSE,    ROSE, ROSE, ROSE, ROSE, ROSE, ROSE,
        WHITE,WHITE,BLACK,TRNS,    BLACK,         BLACK,   RED,  TRNS, WHITE,WHITE
    ),
 };

Warning

Due to reusing LAYOUT macro to define the colors, implementation is not too flexible.

Assumes existence of a LED under every key.
Does not support assigning colors to LEDs that aren’t under a key (eg: indicators or underglow)

It also hasn’t been exhaustively tested, there might be some problems.

enum ledmap_color_t¶ [source]

Available colors

enumerator RED¶ [source]

enumerator ORANGE¶ [source]

enumerator YELLOW¶ [source]

enumerator CHARTREUSE¶ [source]

enumerator GREEN¶ [source]

enumerator SPRING¶ [source]

enumerator CYAN¶ [source]

enumerator AZURE¶ [source]

enumerator BLUE¶ [source]

enumerator VIOLET¶ [source]

enumerator MAGENTA¶ [source]

enumerator ROSE¶ [source]

enumerator TRNS¶ [source]

enumerator WHITE¶ [source]

enumerator BLACK¶ [source]

int rgb_at_ledmap_location(uint8_t layer, uint8_t row, uint8_t col, rgb_t *rgb)¶ [source]

Retrieve the color assigned to a key in the ledmap (transparency gets applied).

Parameters:

layer – Where to look at.
row – Electrical position of the key in the matrix.
col – Electrical position of the key in the matrix.
rgb – Where the value will be written.

Return: Error code.

0: Color was found, and assigned into pointer.
-EINVAL: Some input was wrong.
-ENODATA: TRNS on layer 0 -> Dont overwrite the existing effect.
-ENOTSUP: Value read at this position has no logic defined.

void draw_ledmap(uint8_t led_min, uint8_t led_max)¶ [source]

Assign their color to all leds in the given range.

Parameters:

led_min – First LED to be drawn.
led_max – Last LED to be drawn.

Warning

Since QMK does not (yet?) allow to hook modules into the RGB system, you need to call this function from within rgb_matrix_indicators_advanced_user

ledmap¶

`ledmap`¶