aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorManna Harbour <51143715+manna-harbour@users.noreply.github.com>2019-11-29 09:00:29 +1100
committerJoel Challis <git@zvecr.com>2019-11-28 22:00:29 +0000
commitf9521ffa21c71ed1d5c5e3c72a0d193594d0430f (patch)
tree2a43c9205549d0e410d1995ad76b2a79d555ac42 /docs
parent2048df883200589c20dfc581e39e03703edf0b23 (diff)
downloadqmk_firmware-f9521ffa21c71ed1d5c5e3c72a0d193594d0430f.tar.gz
qmk_firmware-f9521ffa21c71ed1d5c5e3c72a0d193594d0430f.zip
Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484)
* Add shift-to-invert to remaining directional RGB_* keycode pairs RGB_MODE_FORWARD / RGB_MODE_REVERSE invert their functions when shift is held. This change adds the same capabilities to the remaining directional RGB_* keycode pairs. This improves consistency and provides full RGB control in a keymap containing only one keycode from each pair. * remove redundant variable * fix typo * Fix more typos Flyspell is on now I swear!
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_rgb_matrix.md24
-rw-r--r--docs/feature_rgblight.md12
-rw-r--r--docs/keycodes.md38
3 files changed, 39 insertions, 35 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index 3e69361fb..5b834a99d 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -173,16 +173,20 @@ As mentioned earlier, the center of the keyboard by default is expected to be `{
173 173
174All RGB keycodes are currently shared with the RGBLIGHT system: 174All RGB keycodes are currently shared with the RGBLIGHT system:
175 175
176* `RGB_TOG` - toggle 176|Key |Aliases |Description |
177* `RGB_MOD` - cycle through modes 177|-------------------|----------|--------------------------------------------------------------------------------------|
178* `RGB_HUI` - increase hue 178|`RGB_TOG` | |Toggle RGB lighting on or off |
179* `RGB_HUD` - decrease hue 179|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held |
180* `RGB_SAI` - increase saturation 180|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held |
181* `RGB_SAD` - decrease saturation 181|`RGB_HUI` | |Increase hue, decrease hue when Shift is held |
182* `RGB_VAI` - increase value 182|`RGB_HUD` | |Decrease hue, increase hue when Shift is held |
183* `RGB_VAD` - decrease value 183|`RGB_SAI` | |Increase saturation, decrease saturation when Shift is held |
184* `RGB_SPI` - increase speed effect (no EEPROM support) 184|`RGB_SAD` | |Decrease saturation, increase saturation when Shift is held |
185* `RGB_SPD` - decrease speed effect (no EEPROM support) 185|`RGB_VAI` | |Increase value (brightness), decrease value when Shift is held |
186|`RGB_VAD` | |Decrease value (brightness), increase value when Shift is held |
187|`RGB_SPI` | |Increase effect speed (does not support eeprom yet), decrease speed when Shift is held|
188|`RGB_SPD` | |Decrease effect speed (does not support eeprom yet), increase speed when Shift is held|
189
186* `RGB_MODE_*` keycodes will generally work, but are not currently mapped to the correct effects for the RGB Matrix system 190* `RGB_MODE_*` keycodes will generally work, but are not currently mapped to the correct effects for the RGB Matrix system
187 191
188## RGB Matrix Effects 192## RGB Matrix Effects
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 2e9610163..69a6aaaed 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -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 |
diff --git a/docs/keycodes.md b/docs/keycodes.md
index fa01df63d..d777246f6 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -389,12 +389,12 @@ This is a reference only. Each group of keys links to the page documenting their
389|`RGB_TOG` | |Toggle RGB lighting on or off | 389|`RGB_TOG` | |Toggle RGB lighting on or off |
390|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held | 390|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held |
391|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held| 391|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held|
392|`RGB_HUI` | |Increase hue | 392|`RGB_HUI` | |Increase hue, decrease hue when Shift is held |
393|`RGB_HUD` | |Decrease hue | 393|`RGB_HUD` | |Decrease hue, increase hue when Shift is held |
394|`RGB_SAI` | |Increase saturation | 394|`RGB_SAI` | |Increase saturation, decrease saturation when Shift is held |
395|`RGB_SAD` | |Decrease saturation | 395|`RGB_SAD` | |Decrease saturation, increase saturation when Shift is held |
396|`RGB_VAI` | |Increase value (brightness) | 396|`RGB_VAI` | |Increase value (brightness), decrease value when Shift is held |
397|`RGB_VAD` | |Decrease value (brightness) | 397|`RGB_VAD` | |Decrease value (brightness), increase value when Shift is held |
398|`RGB_MODE_PLAIN` |`RGB_M_P `|Static (no animation) mode | 398|`RGB_MODE_PLAIN` |`RGB_M_P `|Static (no animation) mode |
399|`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode | 399|`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode |
400|`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode | 400|`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode |
@@ -407,19 +407,19 @@ This is a reference only. Each group of keys links to the page documenting their
407 407
408## [RGB Matrix Lighting](feature_rgb_matrix.md) 408## [RGB Matrix Lighting](feature_rgb_matrix.md)
409 409
410|Key |Aliases |Description | 410|Key |Aliases |Description |
411|-------------------|----------|--------------------------------------------------------------------| 411|-------------------|----------|--------------------------------------------------------------------------------------|
412|`RGB_TOG` | |Toggle RGB lighting on or off | 412|`RGB_TOG` | |Toggle RGB lighting on or off |
413|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held | 413|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held |
414|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held| 414|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held |
415|`RGB_HUI` | |Increase hue | 415|`RGB_HUI` | |Increase hue, decrease hue when Shift is held |
416|`RGB_HUD` | |Decrease hue | 416|`RGB_HUD` | |Decrease hue, increase hue when Shift is held |
417|`RGB_SAI` | |Increase saturation | 417|`RGB_SAI` | |Increase saturation, decrease saturation when Shift is held |
418|`RGB_SAD` | |Decrease saturation | 418|`RGB_SAD` | |Decrease saturation, increase saturation when Shift is held |
419|`RGB_VAI` | |Increase value (brightness) | 419|`RGB_VAI` | |Increase value (brightness), decrease value when Shift is held |
420|`RGB_VAD` | |Decrease value (brightness) | 420|`RGB_VAD` | |Decrease value (brightness), increase value when Shift is held |
421|`RGB_SPI` | |Increase effect speed (does no support eeprom yet) | 421|`RGB_SPI` | |Increase effect speed (does not support eeprom yet), decrease speed when Shift is held|
422|`RGB_SPD` | |Decrease effect speed (does no support eeprom yet) | 422|`RGB_SPD` | |Decrease effect speed (does not support eeprom yet), increase speed when Shift is held|
423 423
424## [Thermal Printer](feature_thermal_printer.md) 424## [Thermal Printer](feature_thermal_printer.md)
425 425
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-19 12:50:19 +0000