aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_rgb_matrix.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-07-03 08:07:02 +0000
committerQMK Bot <hello@qmk.fm>2021-07-03 08:07:02 +0000
commit8465d28d0fcf08139a13b54f2a1323874cf5a954 (patch)
treea2f1e8f46688b1fb2170797630c945960db302db /docs/feature_rgb_matrix.md
parentb45b9ed536151ded3ec8fd90d1d961632b8a2e73 (diff)
parentfdf71f1aa7c4720b469d0e11ec8169796cdf3930 (diff)
downloadqmk_firmware-8465d28d0fcf08139a13b54f2a1323874cf5a954.tar.gz
qmk_firmware-8465d28d0fcf08139a13b54f2a1323874cf5a954.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs/feature_rgb_matrix.md')
-rw-r--r--docs/feature_rgb_matrix.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index 4bd8e1eb9..675b7a1be 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -694,6 +694,39 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
694} 694}
695``` 695```
696 696
697### Indicator Examples :id=indicator-examples
698
699Caps Lock indicator on alphanumeric flagged keys:
700```c
701void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
702 if (host_keyboard_led_state().caps_lock) {
703 for (uint8_t i = led_min; i <= led_max; i++) {
704 if (g_led_config.flags[i] & LED_FLAG_KEYLIGHT) {
705 rgb_matrix_set_color(i, RGB_RED);
706 }
707 }
708 }
709}
710```
711
712Layer indicator on all flagged keys:
713```c
714void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
715 for (uint8_t i = led_min; i <= led_max; i++) {
716 switch(get_highest_layer(layer_state|default_layer_state)) {
717 case RAISE:
718 rgb_matrix_set_color(i, RGB_BLUE);
719 break;
720 case LOWER:
721 rgb_matrix_set_color(i, RGB_YELLOW);
722 break;
723 default:
724 break;
725 }
726 }
727}
728```
729
697### Suspended state :id=suspended-state 730### Suspended state :id=suspended-state
698To use the suspend feature, make sure that `#define RGB_DISABLE_WHEN_USB_SUSPENDED true` is added to the `config.h` file. 731To use the suspend feature, make sure that `#define RGB_DISABLE_WHEN_USB_SUSPENDED true` is added to the `config.h` file.
699 732