diff options
| author | jpe230 <pablin.123.ra@gmail.com> | 2022-05-20 11:13:40 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-20 09:13:40 -0700 |
| commit | f296e1d1e2b1b49b60aca544bf312ef7a759559e (patch) | |
| tree | 6cacd065eacd3eae9d4c9988fd473df97b13b8d0 /docs | |
| parent | 799a7f98ce82fe3057d2b11b2c2515ab28e80b51 (diff) | |
[Docs] Align LED Matrix docs with RGB matrix docs (#17140)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_led_matrix.md | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/feature_led_matrix.md b/docs/feature_led_matrix.md index 37c74843aa..563fa149a2 100644 --- a/docs/feature_led_matrix.md +++ b/docs/feature_led_matrix.md @@ -264,11 +264,11 @@ enum led_matrix_effects { }; ``` -You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `config.h`: +You can enable a single effect by defining `ENABLE_[EFFECT_NAME]` in your `config.h`: -|Define |Description | -|-------------------------------------------------------|-----------------------------------------------| +|Define |Description | +|-------------------------------------------------------|----------------------------------------------| |`#define ENABLE_LED_MATRIX_ALPHAS_MODS` |Enables `LED_MATRIX_ALPHAS_MODS` | |`#define ENABLE_LED_MATRIX_BREATHING` |Enables `LED_MATRIX_BREATHING` | |`#define ENABLE_LED_MATRIX_BAND` |Enables `LED_MATRIX_BAND` | @@ -278,6 +278,13 @@ You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `con |`#define ENABLE_LED_MATRIX_CYCLE_UP_DOWN` |Enables `LED_MATRIX_CYCLE_UP_DOWN` | |`#define ENABLE_LED_MATRIX_CYCLE_OUT_IN` |Enables `LED_MATRIX_CYCLE_OUT_IN` | |`#define ENABLE_LED_MATRIX_DUAL_BEACON` |Enables `LED_MATRIX_DUAL_BEACON` | +|`#define ENABLE_LED_MATRIX_WAVE_LEFT_RIGHT` |Enables `LED_MATRIX_WAVE_LEFT_RIGHT` | +|`#define ENABLE_LED_MATRIX_WAVE_UP_DOWN` |Enables `LED_MATRIX_WAVE_UP_DOWN` | + +?> These modes don't require any additional defines. + +|Reactive Defines |Description | +|-------------------------------------------------------|----------------------------------------------| |`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_SIMPLE` |Enables `LED_MATRIX_SOLID_REACTIVE_SIMPLE` | |`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_WIDE` |Enables `LED_MATRIX_SOLID_REACTIVE_WIDE` | |`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTIWIDE` |Enables `LED_MATRIX_SOLID_REACTIVE_MULTIWIDE` | @@ -287,8 +294,8 @@ You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `con |`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTINEXUS` |Enables `LED_MATRIX_SOLID_REACTIVE_MULTINEXUS`| |`#define ENABLE_LED_MATRIX_SOLID_SPLASH` |Enables `LED_MATRIX_SOLID_SPLASH` | |`#define ENABLE_LED_MATRIX_SOLID_MULTISPLASH` |Enables `LED_MATRIX_SOLID_MULTISPLASH` | -|`#define ENABLE_LED_MATRIX_WAVE_LEFT_RIGHT` |Enables `LED_MATRIX_WAVE_LEFT_RIGHT` | -|`#define ENABLE_LED_MATRIX_WAVE_UP_DOWN` |Enables `LED_MATRIX_WAVE_UP_DOWN` | + +?> These modes also require the `LED_MATRIX_KEYPRESSES` or `LED_MATRIX_KEYRELEASES` define to be available. ## Custom LED Matrix Effects :id=custom-led-matrix-effects |