From 8a4fae3b32c40f73ba75582da1ec13b59856bf3f Mon Sep 17 00:00:00 2001 From: Albert Y <76888457+filterpaper@users.noreply.github.com> Date: Tue, 11 Jan 2022 00:23:28 +0800 Subject: [PATCH] [Docs] Recommend the use of RGB matrix functions for code (#15744) * Recommend the use of functions instead of keycodes * Commit suggested review Co-authored-by: Nick Brassel Co-authored-by: Nick Brassel --- docs/feature_rgb_matrix.md | 1 + 1 file changed, 1 insertion(+) 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