summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2021-01-15 18:34:12 +1100
committerfauxpark <fauxpark@gmail.com>2021-01-15 18:34:12 +1100
commitca7da3866d8a7a80e5c932ebac40fe0061d00c7f (patch)
tree5686046b1f73ed22253fc74bd4851c77e638a615 /docs
parentab375d3d075c105f09a1ddd0e155f178225518bc (diff)
parent8cf5f72aadc7f287b2716a174730a4b2cc26c900 (diff)
Merge remote-tracking branch 'upstream/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_rgb_matrix.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index bb0acba3bb..e7ede48395 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -318,6 +318,19 @@ You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `con
|`#define DISABLE_RGB_MATRIX_SOLID_SPLASH` |Disables `RGB_MATRIX_SOLID_SPLASH` |
|`#define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH` |Disables `RGB_MATRIX_SOLID_MULTISPLASH` |
+### RGB Matrix Effect Typing Heatmap :id=rgb-matrix-effect-typing-heatmap
+
+This effect will color the RGB matrix according to a heatmap of recently pressed
+keys. Whenever a key is pressed its "temperature" increases as well as that of
+its neighboring keys. The temperature of each key is then decreased
+automatically every 25 milliseconds by default.
+
+In order to change the delay of temperature decrease define
+`RGB_MATRIX_TYPING_HEATMAP_DECREASE_DELAY_MS`:
+
+```c
+#define RGB_MATRIX_TYPING_HEATMAP_DECREASE_DELAY_MS 50
+```
## Custom RGB Matrix Effects :id=custom-rgb-matrix-effects