diff options
Diffstat (limited to 'docs/feature_rgblight.md')
| -rw-r--r-- | docs/feature_rgblight.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md index be4ddfa72..69a6aaaed 100644 --- a/docs/feature_rgblight.md +++ b/docs/feature_rgblight.md | |||
| @@ -6,7 +6,7 @@ QMK has the ability to control RGB LEDs attached to your keyboard. This is commo | |||
| 6 | 6 | ||
| 7 | Some keyboards come with RGB LEDs preinstalled. Others must have them installed after the fact. See the [Hardware Modification](#hardware-modification) section for information on adding RGB lighting to your keyboard. | 7 | Some keyboards come with RGB LEDs preinstalled. Others must have them installed after the fact. See the [Hardware Modification](#hardware-modification) section for information on adding RGB lighting to your keyboard. |
| 8 | 8 | ||
| 9 | Currently QMK supports the following addressable LEDs on AVR microcontrollers (however, the white LED in RGBW variants is not supported): | 9 | Currently QMK supports the following addressable LEDs (however, the white LED in RGBW variants is not supported): |
| 10 | 10 | ||
| 11 | * WS2811, WS2812, WS2812B, WS2812C, etc. | 11 | * WS2811, WS2812, WS2812B, WS2812C, etc. |
| 12 | * SK6812, SK6812MINI, SK6805 | 12 | * SK6812, SK6812MINI, SK6805 |
| @@ -48,12 +48,12 @@ Changing the **Value** sets the overall brightness.<br> | |||
| 48 | |`RGB_TOG` | |Toggle RGB lighting on or off | | 48 | |`RGB_TOG` | |Toggle RGB lighting on or off | |
| 49 | |`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held | | 49 | |`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held | |
| 50 | |`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held| | 50 | |`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held| |
| 51 | |`RGB_HUI` | |Increase hue | | 51 | |`RGB_HUI` | |Increase hue, decrease hue when Shift is held | |
| 52 | |`RGB_HUD` | |Decrease hue | | 52 | |`RGB_HUD` | |Decrease hue, increase hue when Shift is held | |
| 53 | |`RGB_SAI` | |Increase saturation | | 53 | |`RGB_SAI` | |Increase saturation, decrease saturation when Shift is held | |
| 54 | |`RGB_SAD` | |Decrease saturation | | 54 | |`RGB_SAD` | |Decrease saturation, increase saturation when Shift is held | |
| 55 | |`RGB_VAI` | |Increase value (brightness) | | 55 | |`RGB_VAI` | |Increase value (brightness), decrease value when Shift is held | |
| 56 | |`RGB_VAD` | |Decrease value (brightness) | | 56 | |`RGB_VAD` | |Decrease value (brightness), increase value when Shift is held | |
| 57 | |`RGB_MODE_PLAIN` |`RGB_M_P `|Static (no animation) mode | | 57 | |`RGB_MODE_PLAIN` |`RGB_M_P `|Static (no animation) mode | |
| 58 | |`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode | | 58 | |`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode | |
| 59 | |`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode | | 59 | |`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode | |
| @@ -363,8 +363,8 @@ Using the `rgblight_set_clipping_range()` function, you can prepare more buffers | |||
| 363 | You can set the Clipping Range by executing the following code. | 363 | You can set the Clipping Range by executing the following code. |
| 364 | 364 | ||
| 365 | ```c | 365 | ```c |
| 366 | // some soruce | 366 | // some source |
| 367 | rgblight_set_clipping_range(3, 4); | 367 | rgblight_set_clipping_range(3, 4); |
| 368 | ``` | 368 | ``` |
| 369 | <img src="https://user-images.githubusercontent.com/2170248/55743785-2bd82a00-5a6e-11e9-9d4b-1b4ffaf4932b.JPG" alt="clip direct" width="70%"/> | 369 | <img src="https://user-images.githubusercontent.com/2170248/55743785-2bd82a00-5a6e-11e9-9d4b-1b4ffaf4932b.JPG" alt="clip direct" width="70%"/> |
| 370 | 370 | ||
