summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorColin T.A. Gray <colinta@gmail.com>2017-12-04 11:36:24 -0700
committerskullydazed <skullydazed@users.noreply.github.com>2017-12-04 11:12:52 -0800
commit53b043d4ef9da3c60236bc8ac012f59bea7bff20 (patch)
tree4c7401aa48120ba411d79ccb54f17370eb540dcf /docs
parent7b51f050d74c158bc082e811d3feaa31bbf33740 (diff)
adds 'RGB_RMOD' to go through RGB modes in reverse
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_rgblight.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 0a5e2a8b15..9d8f537dfb 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -87,8 +87,8 @@ These control the RGB Lighting functionality.
| Long Name | Short Name | Description |
|-----------|------------|-------------|
||`RGB_TOG`|toggle on/off|
-||`RGB_MOD`|cycle through modes|
-||`RGB_SMOD`|cycle through modes, use reverse direction when shift is hold|
+|`RGB_MODE_FORWARD`|`RGB_MOD`|cycle through modes, use reverse direction when shift is held|
+|`RGB_MODE_REVERSE`|`RGB_RMOD`|cycle through modes in reverse (also suppost shift to go forward)|
||`RGB_HUI`|hue increase|
||`RGB_HUD`|hue decrease|
||`RGB_SAI`|saturation increase|
@@ -104,6 +104,8 @@ These control the RGB Lighting functionality.
|`RGB_MODE_XMAS`|`RGB_M_X`| Switch to the Christmas animation |
|`RGB_MODE_GRADIENT`|`RGB_M_G`| Switch to the static gradient mode |
+note: for backwards compatibility, `RGB_SMOD` is an alias for `RGB_MOD`.
+
## Hardware Modification
![Planck with RGB Underglow](https://raw.githubusercontent.com/qmk/qmk_firmware/master/keyboards/planck/keymaps/yang/planck-with-rgb-underglow.jpg)