General RGB matrix fixes (#2931)

[qmk_firmware.git] / docs / feature_rgb_matrix.md

diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index dfc103247acbf2a9c83e8ecfbf8f8936c86b65ed..5d2db3b9709c5a7a529049dc8b736578d095a5f4 100644 (file)
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -69,6 +69,8 @@ All RGB keycodes are currently shared with the RGBLIGHT system:
        * `RGB_SAD` - decrease saturation
        * `RGB_VAI` - increase value
        * `RGB_VAD` - decrease value
+       * `RGB_SPI` - increase speed effect (no EEPROM support)
+       * `RGB_SPD` - decrease speed effect (no EEPROM support)
 
 
        * `RGB_MODE_*` keycodes will generally work, but are not currently mapped to the correct effects for the RGB Matrix system
@@ -79,7 +81,6 @@ These are the effects that are currently available:
 
        enum rgb_matrix_effects {
                RGB_MATRIX_SOLID_COLOR = 1,
-           RGB_MATRIX_SOLID_REACTIVE,
            RGB_MATRIX_ALPHAS_MODS,
            RGB_MATRIX_DUAL_BEACON,
            RGB_MATRIX_GRADIENT_UP_DOWN,
@@ -92,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,
@@ -116,7 +118,7 @@ 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
 
 ## EEPROM storage