summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-01-10 16:23:47 +0000
committerQMK Bot <hello@qmk.fm>2022-01-10 16:23:47 +0000
commit05b6fbb1f5b9ac2ab848a062a64f84de4e2b6ed2 (patch)
treebb329706fbca9d1f248f983657a1ee4caf4a06eb /docs
parentb4b636112ed1318c14244529c5330ee24f597e47 (diff)
parent8a4fae3b32c40f73ba75582da1ec13b59856bf3f (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_rgb_matrix.md1
-rw-r--r--docs/feature_rgblight.md1
2 files changed, 2 insertions, 0 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index 3a40be5f5e..676588b750 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -417,6 +417,7 @@ All RGB keycodes are currently shared with the RGBLIGHT system:
`RGB_MODE_PLAIN`, `RGB_MODE_BREATHE`, `RGB_MODE_RAINBOW`, and `RGB_MODE_SWIRL` are the only ones that are mapped properly. The rest don't have a direct equivalent, and are not mapped.
+?> `RGB_*` keycodes cannot be used with functions like `tap_code16(RGB_HUD)` as they're 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-idfunctions) should be used instead.
!> By default, if you have both the [RGB Light](feature_rgblight.md) and the 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.
## RGB Matrix Effects :id=rgb-matrix-effects
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 8484586c05..e707502613 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -78,6 +78,7 @@ Changing the **Value** sets the overall brightness.<br>
!> 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.
+?> `RGB_*` keycodes cannot be used with functions like `tap_code16(RGB_HUI)` as they're 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-idfunctions) should be used instead.
## Configuration