aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_rgb_matrix.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2021-07-24 12:17:04 -0700
committerGitHub <noreply@github.com>2021-07-24 20:17:04 +0100
commit0b95ac2e4b29a663258aee475a70a3200d113ac2 (patch)
tree192b0f8ccd6d48adccef5a774f9eb6578aef44cb /docs/feature_rgb_matrix.md
parentab42945c9a716d7fdcb2c50dd184761e105acc03 (diff)
downloadqmk_firmware-0b95ac2e4b29a663258aee475a70a3200d113ac2.tar.gz
qmk_firmware-0b95ac2e4b29a663258aee475a70a3200d113ac2.zip
Clean up remaining RGB_DISABLE_WHEN_USB_SUSPENDED defines (#13689)
Diffstat (limited to 'docs/feature_rgb_matrix.md')
-rw-r--r--docs/feature_rgb_matrix.md27
1 files changed, 0 insertions, 27 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index f3e25f2f1..bd47fb6d3 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -741,30 +741,3 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
741 } 741 }
742} 742}
743``` 743```
744
745### Suspended state :id=suspended-state
746To use the suspend feature, make sure that `#define RGB_DISABLE_WHEN_USB_SUSPENDED true` is added to the `config.h` file.
747
748Additionally add this to your `<keyboard>.c`:
749
750```c
751void suspend_power_down_kb(void) {
752 rgb_matrix_set_suspend_state(true);
753 suspend_power_down_user();
754}
755
756void suspend_wakeup_init_kb(void) {
757 rgb_matrix_set_suspend_state(false);
758 suspend_wakeup_init_user();
759}
760```
761or add this to your `keymap.c`:
762```c
763void suspend_power_down_user(void) {
764 rgb_matrix_set_suspend_state(true);
765}
766
767void suspend_wakeup_init_user(void) {
768 rgb_matrix_set_suspend_state(false);
769}
770```