diff options
| author | Ryan <fauxpark@gmail.com> | 2024-10-13 03:43:50 +1100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-12 18:43:50 +0200 |
| commit | 6fa11bf21913b5ccb531acc3c2baec963f4d384a (patch) | |
| tree | aaf6188a4579949cc1fbac61d0fee5234b97996a /docs/features/rgblight.md | |
| parent | 5c97a78ce6ab45643dcb420ba2ad20c30dcd5b8a (diff) | |
Separate RGBLight/RGB Matrix keycode handling (#23679)
* Separate RGBLight/RGB Matrix keycode handling
* Remove `_DISABLE_KEYCODES` handling
* Update RGB Matrix keycode docs
* Update underglow keycodes for previously migrated boards
* Update keycodes for boards with custom handling
* Fix typos
* Fix bad merge
Diffstat (limited to 'docs/features/rgblight.md')
| -rw-r--r-- | docs/features/rgblight.md | 6 |
1 files changed, 0 insertions, 6 deletions
diff --git a/docs/features/rgblight.md b/docs/features/rgblight.md index 794398a0f9..2afc2eb7d0 100644 --- a/docs/features/rgblight.md +++ b/docs/features/rgblight.md @@ -87,11 +87,6 @@ Changing the **Value** sets the overall brightness.<br> These keycodes cannot be used with functions like `tap_code16()` as they are not USB HID keycodes. If you wish to replicate similar behaviour in custom code within your firmware (e.g. inside `encoder_update_user()` or `process_record_user()`), the equivalent [RGB functions](#functions) should be used instead. ::: - -::: warning -By default, if you have both the RGB Light and the [RGB Matrix](rgb_matrix) feature enabled, these keycodes will work for both features, at the same time. You can disable the keycode functionality by defining the `*_DISABLE_KEYCODES` option for the specific feature. -::: - ## Configuration Your RGB lighting can be configured by placing these `#define`s in your `config.h`: @@ -104,7 +99,6 @@ Your RGB lighting can be configured by placing these `#define`s in your `config. |`RGBLIGHT_LIMIT_VAL` |`255` |The maximum brightness level | |`RGBLIGHT_SLEEP` |*Not defined* |If defined, the RGB lighting will be switched off when the host goes to sleep | |`RGBLIGHT_SPLIT` |*Not defined* |If defined, synchronization functionality for split keyboards is added | -|`RGBLIGHT_DISABLE_KEYCODES`|*Not defined* |If defined, disables the ability to control RGB Light from the keycodes. You must use code functions to control the feature| |`RGBLIGHT_DEFAULT_MODE` |`RGBLIGHT_MODE_STATIC_LIGHT`|The default mode to use upon clearing the EEPROM | |`RGBLIGHT_DEFAULT_HUE` |`0` (red) |The default hue to use upon clearing the EEPROM | |`RGBLIGHT_DEFAULT_SAT` |`UINT8_MAX` (255) |The default saturation to use upon clearing the EEPROM | |