summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick Blyumberg <nblyumberg@gmail.com>2020-05-16 03:35:19 -0400
committerGitHub <noreply@github.com>2020-05-16 00:35:19 -0700
commit142ebaea4650b81da143210438ec3828d81289e9 (patch)
tree6a848518e11664663bb4476ee0c793d205af90ac /docs
parentbbd17def21cbf6df94305da4dd3d3fe51414a94e (diff)
[Docs] Clarify layer transparency keymap.md (#9081)
* Revised the grammar and clarity of the Layer Precedence and Transparency * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md
Diffstat (limited to 'docs')
-rw-r--r--docs/keymap.md20
1 files changed, 16 insertions, 4 deletions
diff --git a/docs/keymap.md b/docs/keymap.md
index ba358edbe0..ef476e87f5 100644
--- a/docs/keymap.md
+++ b/docs/keymap.md
@@ -71,10 +71,22 @@ On the other hand, you can change `layer_state` to overlay the base layer with o
### Layer Precedence and Transparency
-Note that ***higher layer has higher priority on stack of layers***, namely firmware falls down from top layer to bottom to look up keycode. Once it spots keycode other than **`KC_TRNS`**(transparent) on a layer it stops searching and lower layers aren't referred.
-
-You can place `KC_TRANS` on overlay layer changes just part of layout to fall back on lower or base layer.
-Key with `KC_TRANS` (`KC_TRNS` and `_______` are the alias) doesn't has its own keycode and refers to lower valid layers for keycode, instead.
+Note that ***higher layers have higher priority within the stack of layers***. The firmware works its way down from the highest active layers to look up keycodes. Once the firmware locates a keycode other than `KC_TRNS` (transparent) on an active layer, it stops searching, and lower layers aren't referenced.
+
+ ____________
+ / / <--- Higher layer
+ / KC_TRNS //
+ /___________// <--- Lower layer (KC_A)
+ /___________/
+
+ In the above scenario, the non-transparent keys on the higher layer would be usable, but whenever `KC_TRNS` (or equivalent) is defined, the keycode (`KC_A`) on the lower level would be used.
+
+**Note:** Valid ways to denote transparency on a given layer:
+* `KC_TRANSPARENT`
+* `KC_TRNS` (alias)
+* `_______` (alias)
+
+These keycodes allow the processing to fall through to lower layers in search of a non-transparent keycode to process.
## Anatomy of a `keymap.c`