diff options
Diffstat (limited to 'docs/feature_swap_hands.md')
| -rw-r--r-- | docs/feature_swap_hands.md | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/docs/feature_swap_hands.md b/docs/feature_swap_hands.md index 61c66a2c1..92e8e3b10 100644 --- a/docs/feature_swap_hands.md +++ b/docs/feature_swap_hands.md | |||
| @@ -17,15 +17,14 @@ const keypos_t hand_swap_config[MATRIX_ROWS][MATRIX_COLS] = { | |||
| 17 | 17 | ||
| 18 | Note that the array indices are reversed same as the matrix and the values are of type `keypos_t` which is `{col, row}` and all values are zero-based. In the example above, `hand_swap_config[2][4]` (third row, fifth column) would return `{7, 2}` (third row, eighth column). Yes, this is confusing. | 18 | Note that the array indices are reversed same as the matrix and the values are of type `keypos_t` which is `{col, row}` and all values are zero-based. In the example above, `hand_swap_config[2][4]` (third row, fifth column) would return `{7, 2}` (third row, eighth column). Yes, this is confusing. |
| 19 | 19 | ||
| 20 | ## Advanced Swap Commands | 20 | ## Swap Keycodes |
| 21 | 21 | ||
| 22 | |Macro | Description | | 22 | |Key |Description | |
| 23 | |------|-------------| | 23 | |-----------|-------------------------------------------------------------------------| |
| 24 | | `ACTION_SWAP_HANDS()` | Swaps hands when pressed, returns to normal when released (momentary). | | 24 | |`SH_T(key)`|Sends `key` with a tap; momentary swap when held. | |
| 25 | | `ACTION_SWAP_HANDS_TOGGLE()` | Toggles swap on and off with every key press. | | 25 | |`SW_ON` |Turns on swapping and leaves it on. | |
| 26 | | `ACTION_SWAP_HANDS_TAP_TOGGLE()` | Toggles with a tap; momentary when held. | | 26 | |`SW_OFF` |Turn off swapping and leaves it off. Good for returning to a known state.| |
| 27 | | `ACTION_SWAP_HANDS_TAP_KEY(key)`| Sends `key` with a tap; momentary swap when held. | | 27 | |`SW_MON` |Swaps hands when pressed, returns to normal when released (momentary). | |
| 28 | | `ACTION_SWAP_HANDS_ON_OFF()` | Alias for `ACTION_SWAP_HANDS()` | | 28 | |`SW_MOFF` |Momentarily turns off swap. | |
| 29 | | `ACTION_SWAP_HANDS_OFF_ON()` | Momentarily turns off swap. | | 29 | |`SH_TG` |Toggles swap on and off with every key press. | |
| 30 | | `ACTION_SWAP_HANDS_ON()` | Turns on swapping and leaves it on. | | 30 | |`SH_TT` |Toggles with a tap; momentary when held. | |
| 31 | | `ACTION_SWAP_HANDS_OFF()` | Turn off swapping and leaves it off. Good for returning to a known state. | \ No newline at end of file | ||