diff options
Diffstat (limited to 'docs/feature_rgblight.md')
| -rw-r--r-- | docs/feature_rgblight.md | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md index 11d4f89950..7e7699c5b7 100644 --- a/docs/feature_rgblight.md +++ b/docs/feature_rgblight.md @@ -105,7 +105,7 @@ Your RGB lighting can be configured by placing these `#define`s in your `config. ## Effects and Animations Not only can this lighting be whatever color you want, -if `RGBLIGHT_EFFECT_xxxx` or `RGBLIGHT_ANIMATIONS` is defined, you also have a number of animation modes at your disposal: +if `RGBLIGHT_EFFECT_xxxx` is defined, you also have a number of animation modes at your disposal: |Mode number symbol |Additional number |Description | |-----------------------------|-------------------|---------------------------------------| @@ -125,13 +125,14 @@ Check out [this video](https://youtube.com/watch?v=VKrpPAHlisY) for a demonstrat Note: For versions older than 0.6.117, The mode numbers were written directly. In `quantum/rgblight/rgblight.h` there is a contrast table between the old mode number and the current symbol. + ### Effect and Animation Toggles Use these defines to add or remove animations from the firmware. When you are running low on flash space, it can be helpful to disable animations you are not using. |Define |Default |Description | |------------------------------------|-------------|-------------------------------------------------------------------------| -|`RGBLIGHT_ANIMATIONS` |*Not defined*|Enable all additional animation modes. | +|`RGBLIGHT_ANIMATIONS` |*Not defined*|Enable all additional animation modes. (deprecated) | |`RGBLIGHT_EFFECT_ALTERNATING` |*Not defined*|Enable alternating animation mode. | |`RGBLIGHT_EFFECT_BREATHING` |*Not defined*|Enable breathing animation mode. | |`RGBLIGHT_EFFECT_CHRISTMAS` |*Not defined*|Enable christmas animation mode. | @@ -143,6 +144,8 @@ Use these defines to add or remove animations from the firmware. When you are ru |`RGBLIGHT_EFFECT_STATIC_GRADIENT` |*Not defined*|Enable static gradient mode. | |`RGBLIGHT_EFFECT_TWINKLE` |*Not defined*|Enable twinkle animation mode. | +!> `RGBLIGHT_ANIMATIONS` is being deprecated and animation modes should be explicitly defined. + ### Effect and Animation Settings The following options are used to tweak the various animations: @@ -162,14 +165,12 @@ The following options are used to tweak the various animations: |`RGBLIGHT_EFFECT_TWINKLE_PROBABILITY`|`1/127` |Adjusts how likely each LED is to twinkle (on each animation step) | ### Example Usage to Reduce Memory Footprint - 1. Remove `RGBLIGHT_ANIMATIONS` from `config.h`. - 1. Selectively add the animations you want to enable. The following would enable two animations and save about 4KiB: + 1. Selectively disable the animations you want to enable. The following would enable two animations and save about 4KiB: ```diff #undef RGBLED_NUM --#define RGBLIGHT_ANIMATIONS -+#define RGBLIGHT_EFFECT_STATIC_GRADIENT -+#define RGBLIGHT_EFFECT_RAINBOW_SWIRL ++#undef RGBLIGHT_EFFECT_STATIC_GRADIENT ++#undef RGBLIGHT_EFFECT_RAINBOW_SWIRL #define RGBLED_NUM 12 #define RGBLIGHT_HUE_STEP 8 #define RGBLIGHT_SAT_STEP 8 |