Move my keymap to the community folder

[qmk_firmware.git] / docs / feature_rgb_matrix.md

diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index 084e87ec4840efe84e8b6669d2af17f1591e69ec..ed33c7ea4ee912826bc3c1f1441f4d3576826d29 100644 (file)
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -80,8 +80,7 @@ All RGB keycodes are currently shared with the RGBLIGHT system:
 These are the effects that are currently available:
 
        enum rgb_matrix_effects {
-               RGB_MATRIX_SOLID_COLOR = 1,
-           RGB_MATRIX_SOLID_REACTIVE,
+           RGB_MATRIX_SOLID_COLOR = 1,
            RGB_MATRIX_ALPHAS_MODS,
            RGB_MATRIX_DUAL_BEACON,
            RGB_MATRIX_GRADIENT_UP_DOWN,
@@ -94,6 +93,7 @@ These are the effects that are currently available:
            RGB_MATRIX_RAINBOW_MOVING_CHEVRON,
            RGB_MATRIX_JELLYBEAN_RAINDROPS,
        #ifdef RGB_MATRIX_KEYPRESSES
+           RGB_MATRIX_SOLID_REACTIVE,
            RGB_MATRIX_SPLASH,
            RGB_MATRIX_MULTISPLASH,
            RGB_MATRIX_SOLID_SPLASH,
@@ -107,7 +107,7 @@ These are the effects that are currently available:
 Custom layer effects can be done by defining this in your `<keyboard>.c`:
 
     void rgb_matrix_indicators_kb(void) {
-       // rgb_matrix_set_color(index, red, green, blue);
+        rgb_matrix_set_color(index, red, green, blue);
     }
 
 A similar function works in the keymap as `rgb_matrix_indicators_user`.
@@ -118,7 +118,8 @@ A similar function works in the keymap as `rgb_matrix_indicators_user`.
        #define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (not recommened)
        #define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
        #define RGB_DISABLE_WHEN_USB_SUSPENDED false // turn off effects when suspended
-    #define RGB_MATRIX_SKIP_FRAMES 1 // number of frames to skip when displaying animations (0 is full effect)
+    #define RGB_MATRIX_SKIP_FRAMES 1 // number of frames to skip when displaying animations (0 is full effect) if not defined defaults to 1
+    #define RGB_MATRIX_MAXIMUM_BRIGHTNESS 200 // limits maximum brightness of LEDs to 200 out of 255. If not defined maximum brightness is set to 255
 
 ## EEPROM storage