aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_rgblight.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_rgblight.md')
-rw-r--r--docs/feature_rgblight.md38
1 files changed, 19 insertions, 19 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 8f4f08024..554eb2dcd 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -98,25 +98,25 @@ rgblight_sethsv_at(h,s,v, LED); // control a single LED. 0 <= LED < RGBLED_NUM
98 98
99These control the RGB Lighting functionality. 99These control the RGB Lighting functionality.
100 100
101| Long Name | Short Name | Description | 101|Key |Aliases |Description |
102|-----------|------------|-------------| 102|-------------------|----------|--------------------------------------------------------------------|
103||`RGB_TOG`|toggle on/off| 103|`RGB_TOG` | |Toggle RGB lighting on or off |
104|`RGB_MODE_FORWARD`|`RGB_MOD`|cycle through modes, use reverse direction when shift is held| 104|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held |
105|`RGB_MODE_REVERSE`|`RGB_RMOD`|cycle through modes in reverse (also suppost shift to go forward)| 105|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held|
106||`RGB_HUI`|hue increase| 106|`RGB_HUI` | |Increase hue |
107||`RGB_HUD`|hue decrease| 107|`RGB_HUD` | |Decrease hue |
108||`RGB_SAI`|saturation increase| 108|`RGB_SAI` | |Increase saturation |
109||`RGB_SAD`|saturation decrease| 109|`RGB_SAD` | |Decrease saturation |
110||`RGB_VAI`|value (brightness) increase| 110|`RGB_VAI` | |Increase value (brightness) |
111||`RGB_VAD`|value (brightness) decrease| 111|`RGB_VAD` | |Decrease value (brightness) |
112|`RGB_MODE_PLAIN`|`RGB_M_P `| Switch to the static no animation mode | 112|`RGB_MODE_PLAIN` |`RGB_M_P `|Static (no animation) mode |
113|`RGB_MODE_BREATHE`|`RGB_M_B`| Switch to the breathing mode | 113|`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode |
114|`RGB_MODE_RAINBOW`|`RGB_M_R`| Switch to the rainbow mode || 114|`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode |
115|`RGB_MODE_SWIRL`|`RGB_M_SW`| Switch to the swirl mode | 115|`RGB_MODE_SWIRL` |`RGB_M_SW`|Swirl animation mode |
116|`RGB_MODE_SNAKE`|`RGB_M_SN`| Switch to the snake mode | 116|`RGB_MODE_SNAKE` |`RGB_M_SN`|Snake animation mode |
117|`RGB_MODE_KNIGHT`|`RGB_M_K`| Switch to the knight animation | 117|`RGB_MODE_KNIGHT` |`RGB_M_K` |"Knight Rider" animation mode |
118|`RGB_MODE_XMAS`|`RGB_M_X`| Switch to the Christmas animation | 118|`RGB_MODE_XMAS` |`RGB_M_X` |Christmas animation mode |
119|`RGB_MODE_GRADIENT`|`RGB_M_G`| Switch to the static gradient mode | 119|`RGB_MODE_GRADIENT`|`RGB_M_G` |Static gradient animation mode |
120 120
121note: for backwards compatibility, `RGB_SMOD` is an alias for `RGB_MOD`. 121note: for backwards compatibility, `RGB_SMOD` is an alias for `RGB_MOD`.
122 122