diff options
Diffstat (limited to 'docs/feature_rgblight.md')
-rw-r--r-- | docs/feature_rgblight.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md index 79977b7aa..994a014a2 100644 --- a/docs/feature_rgblight.md +++ b/docs/feature_rgblight.md | |||
@@ -74,6 +74,7 @@ Changing the **Value** sets the overall brightness.<br> | |||
74 | |`RGB_MODE_XMAS` |`RGB_M_X` |Christmas animation mode | | 74 | |`RGB_MODE_XMAS` |`RGB_M_X` |Christmas animation mode | |
75 | |`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode | | 75 | |`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode | |
76 | |`RGB_MODE_RGBTEST` |`RGB_M_T` |Red, Green, Blue test animation mode | | 76 | |`RGB_MODE_RGBTEST` |`RGB_M_T` |Red, Green, Blue test animation mode | |
77 | |`RGB_MODE_TWINKLE` |`RGB_M_TW`|Twinkle animation mode | | ||
77 | 78 | ||
78 | !> By default, if you have both the RGB Light and the [RGB Matrix](feature_rgb_matrix.md) 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. | 79 | !> By default, if you have both the RGB Light and the [RGB Matrix](feature_rgb_matrix.md) 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. |
79 | 80 | ||
@@ -309,6 +310,18 @@ void post_process_record_user(uint16_t keycode, keyrecord_t *record) { | |||
309 | } | 310 | } |
310 | ``` | 311 | ``` |
311 | 312 | ||
313 | You can also use `rgblight_blink_layer_repeat` to specify the amount of times the layer is supposed to blink. Using the layers from above, | ||
314 | ```c | ||
315 | void post_process_record_user(uint16_t keycode, keyrecord_t *record) { | ||
316 | switch (keycode) { | ||
317 | case DEBUG: | ||
318 | rgblight_blink_layer_repeat(debug_enable ? 0 : 1, 200, 3); | ||
319 | break; | ||
320 | } | ||
321 | } | ||
322 | ``` | ||
323 | would turn the layer 0 (or 1) on and off again three times when `DEBUG` is pressed. | ||
324 | |||
312 | ### Overriding RGB Lighting on/off status | 325 | ### Overriding RGB Lighting on/off status |
313 | 326 | ||
314 | 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`. | 327 | 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`. |