diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config_options.md | 3 | ||||
| -rw-r--r-- | docs/feature_rgblight.md | 2 |
2 files changed, 5 insertions, 0 deletions
diff --git a/docs/config_options.md b/docs/config_options.md index f76685702..b96079e60 100644 --- a/docs/config_options.md +++ b/docs/config_options.md @@ -192,6 +192,9 @@ If you define these options you will enable the associated feature, which may in * run RGB animations * `#define RGBLIGHT_LAYERS` * Lets you define [lighting layers](feature_rgblight.md?id=lighting-layers) that can be toggled on or off. Great for showing the current keyboard layer or caps lock state. +* `#define RGBLIGHT_MAX_LAYERS` + * Defaults to 8. Can be expanded up to 32 if more [lighting layers](feature_rgblight.md?id=lighting-layers) are needed. + * Note: Increasing the maximum will increase the firmware size and slow sync on split keyboards. * `#define RGBLIGHT_LAYER_BLINK` * Adds ability to [blink](feature_rgblight.md?id=lighting-layer-blink) a lighting layer for a specified number of milliseconds (e.g. to acknowledge an action). * `#define RGBLED_NUM 12` diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md index 045d97775..7e54bfef3 100644 --- a/docs/feature_rgblight.md +++ b/docs/feature_rgblight.md @@ -186,6 +186,8 @@ it easy to use your underglow LEDs as status indicators to show which keyboard l ### Defining Lighting Layers :id=defining-lighting-layers +By default, 8 layers are possible. This can be expanded to as many as 32 by overriding the definition of `RGBLIGHT_MAX_LAYERS` in `config.h` (e.g. `#define RGBLIGHT_MAX_LAYERS 32`). Please note, if you use a split keyboard, you will need to flash both sides of the split after changing this. Also, increasing the maximum will increase the firmware size, and will slow sync on split keyboards. + To define a layer, we modify `keymap.c` to list out LED ranges and the colors we want to overlay on them using an array of `rgblight_segment_t` using the `RGBLIGHT_LAYER_SEGMENTS` macro. We can define multiple layers and enable/disable them independently: ```c |