diff options
| author | Joshua Diamond <josh@windowoffire.com> | 2020-05-13 16:39:05 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-13 21:39:05 +0100 |
| commit | a8a8bf0ff3d6e1c9637079b925b30cf7eb8913fd (patch) | |
| tree | 3e7f1d53536711151fb7f8aebe63ab4d41f1d298 /docs/feature_rgblight.md | |
| parent | fadd3cb4617fe7e48c802c4470a50df36e6c5109 (diff) | |
Allow expanding from 8 to 32 RGB Lighting Layers (#8941)
* Allow 16 lighting layers
* Require #define RGBLIGHT_LAYERS_16 to enable 16 layers
* Override RGBLIGHT_MAX_LAYERS to set maximum number of lighting layers
* Enforce lower bound on RGBLIGHT_MAX_LAYERS
Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
* Fix an error in the check for valid RGBLIGHT_MAX_LAYERS
* Don't use bitfield / PACKED, as it causes bloat
* Update documentation re: up to 32 lighting layers
* Run cformat
* Add note about increasing FW size in docs/config_options.md
Co-authored-by: Drashna Jaelre <drashna@live.com>
* Remove no-longer-valid comment
* Add doc note that split sync will be slower
Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'docs/feature_rgblight.md')
| -rw-r--r-- | docs/feature_rgblight.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md index 045d97775d..7e54bfef3c 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 |