summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2020-12-23 05:59:58 +0000
committerQMK Bot <hello@qmk.fm>2020-12-23 05:59:58 +0000
commitf971934dab17316f69978074ae86db8da4fcf7ab (patch)
treead0a258970e3124da16625720bc00cb3552e7c7a
parent3656644c35a176948587e893487806343bc88cc1 (diff)
parent498d89f4b345e3f5bccbbb8ac82df4eb7c582b1b (diff)
Merge remote-tracking branch 'origin/master' into develop
-rw-r--r--docs/feature_rgb_matrix.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index f8b0653551..a9e711c9f2 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -306,6 +306,12 @@ To declare new effects, create a new `rgb_matrix_user/kb.inc` that looks somethi
`rgb_matrix_user.inc` should go in the root of the keymap directory.
`rgb_matrix_kb.inc` should go in the root of the keyboard directory.
+To use custom effects in your code, simply prepend `RGB_MATRIX_CUSTOM_` to the effect name specified in `RGB_MATRIX_EFFECT()`. For example, an effect declared as `RGB_MATRIX_EFFECT(my_cool_effect)` would be referenced with:
+
+```c
+rgb_matrix_mode(RGB_MATRIX_CUSTOM_my_cool_effect);
+```
+
```c
// !!! DO NOT ADD #pragma once !!! //