aboutsummaryrefslogtreecommitdiffstats
path: root/docs/keymap.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2020-02-27 20:53:50 -0800
committerskullydazed <skullydazed@users.noreply.github.com>2020-03-05 16:00:10 -0800
commit54c58ea6de61a0f1fefa06e8271e2e11f9027940 (patch)
tree2ce4163cda8164edccd6f06f6e384861a205006c /docs/keymap.md
parenta95a314f78fd96aca7cc496b10bd310e28b1b66e (diff)
downloadfirmware-54c58ea6de61a0f1fefa06e8271e2e11f9027940.tar.gz
firmware-54c58ea6de61a0f1fefa06e8271e2e11f9027940.tar.bz2
firmware-54c58ea6de61a0f1fefa06e8271e2e11f9027940.zip
Add explicit id tags to externally linked headers
Diffstat (limited to 'docs/keymap.md')
-rw-r--r--docs/keymap.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/keymap.md b/docs/keymap.md
index 457dbf67e..ba358edbe 100644
--- a/docs/keymap.md
+++ b/docs/keymap.md
@@ -3,7 +3,7 @@
QMK keymaps are defined inside a C source file. The data structure is an array of arrays. The outer array is a list of layer arrays while the inner layer array is a list of keys. Most keyboards define a `LAYOUT()` macro to help you create this array of arrays.
-## Keymap and Layers
+## Keymap and Layers :id=keymap-and-layers
In QMK, **`const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS]`** holds multiple **layers** of keymap information in **16 bit** data holding the **action code**. You can define **32 layers** at most.
For trivial key definitions, the higher 8 bits of the **action code** are all 0 and the lower 8 bits holds the USB HID usage code generated by the key as **keycode**.
@@ -27,7 +27,8 @@ Respective layers can be validated simultaneously. Layers are indexed with 0 to
Sometimes, the action code stored in keymap may be referred as keycode in some documents due to the TMK history.
-### Keymap Layer Status
+### Keymap Layer Status :id=keymap-layer-status
+
The state of the Keymap layer is determined by two 32 bit parameters:
* **`default_layer_state`** indicates a base keymap layer (0-31) which is always valid and to be referred (the default layer).