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/feature_led_matrix.md | |
| parent | 799a7f98ce82fe3057d2b11b2c2515ab28e80b51 (diff) | |
[Docs] Align LED Matrix docs with RGB matrix docs (#17140)
Diffstat (limited to 'docs/feature_led_matrix.md')
| -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 { | |||
| 264 | }; | 264 | }; |
| 265 | ``` | 265 | ``` |
| 266 | 266 | ||
| 267 | You can disable a single effect by defining `DISABLE_[EFFECT_NAME]` in your `config.h`: | 267 | You can enable a single effect by defining `ENABLE_[EFFECT_NAME]` in your `config.h`: |
| 268 | 268 | ||
| 269 | 269 | ||
| 270 | |Define |Description | | 270 | |Define |Description | |
| 271 | |-------------------------------------------------------|-----------------------------------------------| | 271 | |-------------------------------------------------------|----------------------------------------------| |
| 272 | |`#define ENABLE_LED_MATRIX_ALPHAS_MODS` |Enables `LED_MATRIX_ALPHAS_MODS` | | 272 | |`#define ENABLE_LED_MATRIX_ALPHAS_MODS` |Enables `LED_MATRIX_ALPHAS_MODS` | |
| 273 | |`#define ENABLE_LED_MATRIX_BREATHING` |Enables `LED_MATRIX_BREATHING` | | 273 | |`#define ENABLE_LED_MATRIX_BREATHING` |Enables `LED_MATRIX_BREATHING` | |
| 274 | |`#define ENABLE_LED_MATRIX_BAND` |Enables `LED_MATRIX_BAND` | | 274 | |`#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 | |||
| 278 | |`#define ENABLE_LED_MATRIX_CYCLE_UP_DOWN` |Enables `LED_MATRIX_CYCLE_UP_DOWN` | | 278 | |`#define ENABLE_LED_MATRIX_CYCLE_UP_DOWN` |Enables `LED_MATRIX_CYCLE_UP_DOWN` | |
| 279 | |`#define ENABLE_LED_MATRIX_CYCLE_OUT_IN` |Enables `LED_MATRIX_CYCLE_OUT_IN` | | 279 | |`#define ENABLE_LED_MATRIX_CYCLE_OUT_IN` |Enables `LED_MATRIX_CYCLE_OUT_IN` | |
| 280 | |`#define ENABLE_LED_MATRIX_DUAL_BEACON` |Enables `LED_MATRIX_DUAL_BEACON` | | 280 | |`#define ENABLE_LED_MATRIX_DUAL_BEACON` |Enables `LED_MATRIX_DUAL_BEACON` | |
| 281 | |`#define ENABLE_LED_MATRIX_WAVE_LEFT_RIGHT` |Enables `LED_MATRIX_WAVE_LEFT_RIGHT` | | ||
| 282 | |`#define ENABLE_LED_MATRIX_WAVE_UP_DOWN` |Enables `LED_MATRIX_WAVE_UP_DOWN` | | ||
| 283 | |||
| 284 | ?> These modes don't require any additional defines. | ||
| 285 | |||
| 286 | |Reactive Defines |Description | | ||
| 287 | |-------------------------------------------------------|----------------------------------------------| | ||
| 281 | |`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_SIMPLE` |Enables `LED_MATRIX_SOLID_REACTIVE_SIMPLE` | | 288 | |`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_SIMPLE` |Enables `LED_MATRIX_SOLID_REACTIVE_SIMPLE` | |
| 282 | |`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_WIDE` |Enables `LED_MATRIX_SOLID_REACTIVE_WIDE` | | 289 | |`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_WIDE` |Enables `LED_MATRIX_SOLID_REACTIVE_WIDE` | |
| 283 | |`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTIWIDE` |Enables `LED_MATRIX_SOLID_REACTIVE_MULTIWIDE` | | 290 | |`#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 | |||
| 287 | |`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTINEXUS` |Enables `LED_MATRIX_SOLID_REACTIVE_MULTINEXUS`| | 294 | |`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTINEXUS` |Enables `LED_MATRIX_SOLID_REACTIVE_MULTINEXUS`| |
| 288 | |`#define ENABLE_LED_MATRIX_SOLID_SPLASH` |Enables `LED_MATRIX_SOLID_SPLASH` | | 295 | |`#define ENABLE_LED_MATRIX_SOLID_SPLASH` |Enables `LED_MATRIX_SOLID_SPLASH` | |
| 289 | |`#define ENABLE_LED_MATRIX_SOLID_MULTISPLASH` |Enables `LED_MATRIX_SOLID_MULTISPLASH` | | 296 | |`#define ENABLE_LED_MATRIX_SOLID_MULTISPLASH` |Enables `LED_MATRIX_SOLID_MULTISPLASH` | |
| 290 | |`#define ENABLE_LED_MATRIX_WAVE_LEFT_RIGHT` |Enables `LED_MATRIX_WAVE_LEFT_RIGHT` | | 297 | |
| 291 | |`#define ENABLE_LED_MATRIX_WAVE_UP_DOWN` |Enables `LED_MATRIX_WAVE_UP_DOWN` | | 298 | ?> These modes also require the `LED_MATRIX_KEYPRESSES` or `LED_MATRIX_KEYRELEASES` define to be available. |
| 292 | 299 | ||
| 293 | ## Custom LED Matrix Effects :id=custom-led-matrix-effects | 300 | ## Custom LED Matrix Effects :id=custom-led-matrix-effects |
| 294 | 301 | ||
