summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoshua Diamond <josh@windowoffire.com>2020-06-01 05:02:28 -0400
committerGitHub <noreply@github.com>2020-06-01 11:02:28 +0200
commite2e287ec5f720839efd8f7cecf447763433cda27 (patch)
treefba21d51c2a44c3c088872ce940c2d0e48b3fa45 /docs
parentdfcd4f0d25bb3db8798ad8bb06da0fab68e7cf25 (diff)
downloadqmk_firmware-e2e287ec5f720839efd8f7cecf447763433cda27.tar.gz
qmk_firmware-e2e287ec5f720839efd8f7cecf447763433cda27.zip
Option to allow lighting layers when RGB Lighting is off (#9051)
Diffstat (limited to 'docs')
-rw-r--r--docs/config_options.md2
-rw-r--r--docs/feature_rgblight.md4
2 files changed, 6 insertions, 0 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index b96079e605..ab26fd46ce 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -197,6 +197,8 @@ If you define these options you will enable the associated feature, which may in
* 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 RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF`
+ * If defined, then [lighting layers](feature_rgblight?id=overriding-rgb-lighting-onoff-status) will be shown even if RGB Light is off.
* `#define RGBLED_NUM 12`
* number of LEDs
* `#define RGBLIGHT_SPLIT`
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 7f5c8a36c1..5921e9941a 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -278,6 +278,10 @@ void post_process_record_user(uint16_t keycode, keyrecord_t *record) {
}
```
+### Overriding RGB Lighting on/off status
+
+Normally lighting layers are not shown when RGB Lighting is disabled (e.g. with `RGB_TOG` keycode). If you would like lighting layers to work even when the RGB Lighting is otherwise off, add `#define RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF` to your `config.h`.
+
## Functions
If you need to change your RGB lighting in code, for example in a macro to change the color whenever you switch layers, QMK provides a set of functions to assist you. See [`rgblight.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight.h) for the full list, but the most commonly used functions include: