2024-05-30 02:02:10 +00:00
<!DOCTYPE html>
< html lang = "en-US" dir = "ltr" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< title > Layers | QMK Firmware< / title >
< meta name = "description" content = "Documentation for QMK Firmware" >
< meta name = "generator" content = "VitePress v1.1.3" >
2025-01-29 19:22:29 +00:00
< link rel = "preload stylesheet" href = "/assets/style.CGNt89Ph.css" as = "style" >
2024-05-30 02:02:10 +00:00
2025-01-29 19:28:04 +00:00
< script type = "module" src = "/assets/app.5wOGx_7d.js" > < / script >
2024-05-30 02:02:10 +00:00
< link rel = "preload" href = "/assets/inter-roman-latin.Di8DUHzh.woff2" as = "font" type = "font/woff2" crossorigin = "" >
2025-01-29 19:28:04 +00:00
< link rel = "modulepreload" href = "/assets/chunks/theme.DsYN-t6L.js" >
2025-01-29 19:22:29 +00:00
< link rel = "modulepreload" href = "/assets/chunks/framework.Cauyuiy8.js" >
< link rel = "modulepreload" href = "/assets/feature_layers.md.RQMXu6l3.lean.js" >
2024-05-30 02:02:10 +00:00
< script id = "check-dark-mode" > ( ( ) => { const e = localStorage . getItem ( "vitepress-theme-appearance" ) || "auto" , a = window . matchMedia ( "(prefers-color-scheme: dark)" ) . matches ; ( ! e || e === "auto" ? a : e === "dark" ) && document . documentElement . classList . add ( "dark" ) } ) ( ) ; < / script >
< script id = "check-mac-os" > document . documentElement . classList . toggle ( "mac" , /Mac|iPhone|iPod|iPad/i . test ( navigator . platform ) ) ; < / script >
< / head >
< body >
2024-12-13 09:44:09 +00:00
< div id = "app" > < div class = "Layout" data-v-5d98c3a5 > <!-- [ --> <!-- ] --> <!-- [ --> < span tabindex = "-1" data-v-0f60ec36 > < / span > < a href = "#VPContent" class = "VPSkipLink visually-hidden" data-v-0f60ec36 > Skip to content < / a > <!-- ] --> <!-- --> < header class = "VPNav" data-v-5d98c3a5 data-v-ae24b3ad > < div class = "VPNavBar has-sidebar top" data-v-ae24b3ad data-v-ccf7ddec > < div class = "wrapper" data-v-ccf7ddec > < div class = "container" data-v-ccf7ddec > < div class = "title" data-v-ccf7ddec > < div class = "VPNavBarTitle has-sidebar" data-v-ccf7ddec data-v-ab179fa1 > < a class = "title" href = "/" data-v-ab179fa1 > <!-- [ --> <!-- ] --> <!-- [ --> <!-- [ --> <!-- [ --> < img class = "VPImage dark logo" src = "/qmk-logo-dark.svg" alt data-v-8426fc1a > <!-- ] --> <!-- [ --> < img class = "VPImage light logo" src = "/qmk-logo-light.svg" alt data-v-8426fc1a > <!-- ] --> <!-- ] --> <!-- ] --> < span data-v-ab179fa1 > QMK Firmware< / span > <!-- [ --> <!-- ] --> < / a > < / div > < / div > < div class = "content" data-v-ccf7ddec > < div class = "content-body" data-v-ccf7ddec > <!-- [ --> <!-- ] --> < div class = "VPNavBarSearch search" data-v-ccf7ddec > <!-- [ --> <!-- --> < div id = "local-search" > < button type = "button" class = "DocSearch DocSearch-Button" aria-label = "Search" > < span class = "DocSearch-Button-Container" > < span class = "vp-icon DocSearch-Search-Icon" > < / span > < span class = "DocSearch-Button-Placeholder" > Search< / span > < / span > < span class = "DocSearch-Button-Keys" > < kbd class = "DocSearch-Button-Key" > < / kbd > < kbd class = "DocSearch-Button-Key" > K< / kbd > < / span > < / button > < / div > <!-- ] --> < / div > < nav aria-labelledby = "main-nav-aria-label" class = "VPNavBarMenu menu" data-v-ccf7ddec data-v-7f418b0f > < span id = "main-nav-aria-label" class = "visually-hidden" data-v-7f418b0f > Main Navigation< / span > <!-- [ --> <!-- [ --> < a class = "VPLink link VPNavBarMenuLink" href = "/" tabindex = "0" data-v-7f418b0f data-v-9c663999 > <!-- [ --> < span data-v-9c663999 > Home< / span > <!-- ] --> < / a > <!-- ] --> <!-- ] --> < / nav > <!-- --> < div class = "VPNavBarAppearance appearance" data-v-ccf7ddec data-v-e6aabb21 > < button class = "VPSwitch VPSwitchAppearance" type = "button" role = "switch" title = "Switch to dark theme" aria-checked = "false" data-v-e6aabb21 data-v-d1f28634 data-v-1d5665e3 > < span class = "check" data-v-1d5665e3 > < span class = "icon" data-v-1d5665e3 > <!-- [ --> < span class = "vpi-sun sun" data-v-d1f28634 > < / span > < span class = "vpi-moon moon" data-v-d1f28634 > < / span > <!-- ] --> < / span > < / span > < / button > < / div > < div class = "VPSocialLinks VPNavBarSocialLinks social-links" data-v-ccf7ddec data-v-0394ad82 data-v-7bc22406 > <!-- [ --> < a class = "VPSocialLink no-icon" href = "https://reddit.com/r/olkb" aria-label target = "_blank" rel = "noopener" data-v-7bc22406 data-v-eee4e7cb > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 50 50" width = "50px" height = "50px" > < path d = "M 29 3 C 28 . 0625 3 27 . 164063 3 . 382813 26 . 5 4 C 25 . 835938 4 . 617188 25 . 363281 5 . 433594 25 6 . 40625 C 24 . 355469 8 . 140625 24 . 085938 10 . 394531 24 . 03125 13 . 03125 C 19 . 234375 13 . 179688 14 . 820313 14 . 421875 11 . 28125 16 . 46875 C 10 . 214844 15 . 46875 8 . 855469 14 . 96875 7 . 5 14 . 96875 C 6 . 089844 14 . 96875 4 . 675781 15 . 511719 3 . 59375 16 . 59375 C 1 . 425781 18 . 761719 1 . 425781 22 . 238281 3 . 59375 24 . 40625 L 3 . 84375 24 . 65625 C 3 . 3125 26 . 035156 3 27 . 488281 3 29 C 3 33 . 527344 5 . 566406 37 . 585938 9 . 5625 40 . 4375 C 13 . 558594 43 . 289063 19 . 007813 45 25 45 C 30 . 992188 45 36 . 441406 43 . 289063 40 . 4375 40 . 4375 C 44 . 433594 37 . 585938 47 33 . 527344 47 29 C 47 27 . 488281 46 . 6875 26 . 035156 46 . 15625 24 . 65625 L 46 . 40625 24 . 40625 C 48 . 574219 22 . 238281 48 . 574219 18 . 761719 46 . 40625 16 . 59375 C 45 . 324219 15 . 511719 43 . 910156 14 . 96875 42 . 5 14 . 96875 C 41 . 144531 14 . 96875 39 . 785156 15 . 46875 38 . 71875 16 . 46875 C 35 . 195313 14 . 433594 30 . 800781 13 . 191406 26 . 03125 13 . 03125 C 26 . 09375 10 . 546875 26 . 363281 8 . 46875 26 . 875 7 . 09375 C 27 . 164063 6 . 316406 27 . 527344 5 . 757813 27 . 875 5 . 4375 C 28 . 222656 5 . 117188 28 . 539063 5 29 5 C 29 . 460938 5 29 . 683594 5 . 125 30 . 03125 5 . 40625 C 30 . 378906 5 . 6875 30 . 785156 6 . 148438 31 . 3125 6 . 6875 C 32 . 253906 7 . 652344 33 . 695313 8 . 714844 36 . 09375 8 . 9375 C 36 . 539063 11 . 238281 38 . 574219 13 41 13 C 43 . 75 13 46 10 . 75 46 8 C 46 5 . 25 43 . 75 3 41 3 C 38 . 605469 3 36 . 574219 4 . 710938 36 . 09375 6 . 96875 C 34 . 3125 6 . 796875 33 . 527344 6 . 109375 32 . 75 5 . 3125 C 32 . 300781 4 . 851563 31 . 886719 4
2024-05-30 02:02:10 +00:00
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > switch< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > get_highest_layer< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (state)) {< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > case< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > _RAISE:< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > rgblight_setrgb< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 00< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 00< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > FF< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > );< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > break< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ;< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > case< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > _LOWER:< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > rgblight_setrgb< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > FF< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 00< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 00< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > );< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > break< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ;< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > case< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > _PLOVER:< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > rgblight_setrgb< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 00< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > FF< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 00< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > );< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > break< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ;< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > case< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > _ADJUST:< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > rgblight_setrgb< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 7A< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 00< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > FF< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > );< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > break< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ;< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > default< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > :< / span > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > // for any other layers, or the default layer< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > rgblight_setrgb< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 00< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > FF< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > 0x< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > FF< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > );< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > break< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ;< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > }< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > return< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > state;< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > }< / span > < / span > < / code > < / pre > < / div > < h3 id = "example-keycode-to-cycle-through-layers" tabindex = "-1" > Example: Keycode to cycle through layers < a class = "header-anchor" href = "#example-keycode-to-cycle-through-layers" aria-label = "Permalink to "Example: Keycode to cycle through layers"" > < / a > < / h3 > < p > This example shows how to implement a custom keycode to cycle through a range of layers.< / p > < div class = "language-c vp-adaptive-theme" > < button title = "Copy Code" class = "copy" > < / button > < span class = "lang" > c< / span > < pre class = "shiki shiki-themes github-light github-dark vp-code" > < code > < span class = "line" > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > // Define the keycode, `QK_USER` avoids collisions with existing keycodes< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > enum< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > keycodes {< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > KC_CYCLE_LAYERS < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > QK_USER,< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > };< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > // 1st layer on the cycle< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > #define< / span > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > LAYER_CYCLE_START< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > // Last layer on the cycle< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > #define< / span > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > LAYER_CYCLE_END< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 4< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > // Add the behaviour of this new keycode< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > bool< / span > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > process_record_user< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > uint16_t< / span > < span style = "--shiki-light:#E36209;--shiki-dark:#FFAB70;" > keycode< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > keyrecord_t< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > *< / span > < span style = "--shiki-light:#E36209;--shiki-dark:#FFAB70;" > record< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ) {< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > switch< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (keycode) {< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > case< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > KC_CYCLE_LAYERS:< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > // Our logic will happen on presses, nothing is done on releases< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > if< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > !< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > record< / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > -> < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > event.pressed) { < / span > < / span >
< span class = "line" > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > // We' ve already handled the keycode (doing nothing), let QMK know so no further code is run unnecessarily< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > return< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > false< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ;< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > }< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > uint8_t< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > current_layer < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > get_highest_layer< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (layer_state);< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > // Check if we are within the range, if not quit< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > if< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (current_layer < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > > < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > LAYER_CYCLE_END < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > ||< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > current_layer < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > < < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > LAYER_CYCLE_START) {< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > return< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > false< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ;< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > }< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > uint8_t< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > next_layer < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > current_layer < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > +< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ;< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > if< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (next_layer < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > > < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > LAYER_CYCLE_END) {< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > next_layer < / span > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > =< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > LAYER_CYCLE_START;< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > }< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#6F42C1;--shiki-dark:#B392F0;" > layer_move< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > (next_layer);< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > return< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > false< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ;< / span > < / span >
< span class = "line" > < / span >
< span class = "line" > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > // Process other keycodes normally< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > default< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > :< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#D73A49;--shiki-dark:#F97583;" > return< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > true< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ;< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > }< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > }< / span > < / span >
< span class = "line" > < / span >
2024-11-27 10:33:24 +00:00
< span class = "line" > < span style = "--shiki-light:#6A737D;--shiki-dark:#6A737D;" > // Place `KC_CYCLE_LAYERS` as a keycode in your keymap< / span > < / span > < / code > < / pre > < / div > < p > Use the < code > IS_LAYER_ON_STATE(state, layer)< / code > and < code > IS_LAYER_OFF_STATE(state, layer)< / code > macros to check the status of a particular layer.< / p > < p > Outside of < code > layer_state_set_*< / code > functions, you can use the < code > IS_LAYER_ON(layer)< / code > and < code > IS_LAYER_OFF(layer)< / code > macros to check global layer state.< / p > < h3 id = "layer-state-set-function-documentation" tabindex = "-1" > < code > layer_state_set_*< / code > Function Documentation < a class = "header-anchor" href = "#layer-state-set-function-documentation" aria-label = "Permalink to "`layer_state_set_*` Function Documentation"" > < / a > < / h3 > < ul > < li > Keyboard/Revision: < code > layer_state_t layer_state_set_kb(layer_state_t state)< / code > < / li > < li > Keymap: < code > layer_state_t layer_state_set_user(layer_state_t state)< / code > < / li > < / ul > < p > The < code > state< / code > is the bitmask of the active layers, as explained in the < a href = "./keymap#keymap-layer-status" > Keymap Overview< / a > < / p > < / div > < / div > < / main > < footer class = "VPDocFooter" data-v-39a288b8 data-v-09de1c0f > <!-- [ --> <!-- ] --> < div class = "edit-info" data-v-09de1c0f > < div class = "edit-link" data-v-09de1c0f > < a class = "VPLink link vp-external-link-icon no-icon edit-link-button" href = "https://github.com/qmk/qmk_firmware/edit/master/docs/feature_layers.md" target = "_blank" rel = "noreferrer" data-v-09de1c0f > <!-- [ --> < span class = "vpi-square-pen edit-link-icon" data-v-09de1c0f > < / span > Edit this page<!-- ] --> < / a > < / div > <!-- --> < / div > < nav class = "prev-next" data-v-09de1c0f > < div class = "pager" data-v-09de1c0f > < a class = "VPLink link pager-link prev" href = "/features/key_overrides" data-v-09de1c0f > <!-- [ --> < span class = "desc" data-v-09de1c0f > Previous page< / span > < span class = "title" data-v-09de1c0f > Key Overrides< / span > <!-- ] --> < / a > < / div > < div class = "pager" data-v-09de1c0f > < a class = "VPLink link pager-link next" href = "/features/layer_lock" data-v-09de1c0f > <!-- [ --> < span class = "desc" data-v-09de1c0f > Next page< / span > < span class = "title" data-v-09de1c0f > Layer Lock< / span > <!-- ] --> < / a > < / div > < / nav > < / footer > <!-- [ --> <!-- ] --> < / div > < / div > < / div > <!-- [ --> <!-- ] --> < / div > < / div > <!-- --> <!-- [ --> <!-- ] --> < / div > < / div >
2025-01-29 19:28:04 +00:00
< script > w i n d o w . _ _ V P _ H A S H _ M A P _ _ = J S O N . p a r s e ( " { \ " c h a n g e l o g _ 2 0 1 9 0 8 3 0 . m d \ " : \ " D g 7 C R 0 a 9 \ " , \ " c h a n g e l o g _ 2 0 2 0 0 2 2 9 . m d \ " : \ " r x a P 8 f 5 R \ " , \ " c h a n g e l o g _ 2 0 2 0 0 5 3 0 . m d \ " : \ " B c d K _ p R i \ " , \ " c h a n g e l o g _ 2 0 2 0 0 8 2 9 . m d \ " : \ " C R R 9 P T Y Q \ " , \ " c h a n g e l o g _ 2 0 2 0 1 1 2 8 . m d \ " : \ " B u l 9 Y L 0 S \ " , \ " c h a n g e l o g _ 2 0 2 1 0 2 2 7 . m d \ " : \ " D w 8 v I K _ 1 \ " , \ " c h a n g e l o g _ 2 0 2 1 0 5 2 9 . m d \ " : \ " D d d G E d T z \ " , \ " c h a n g e l o g _ 2 0 2 1 0 8 2 8 . m d \ " : \ " D 7 l B J v G v \ " , \ " c h a n g e l o g _ 2 0 2 1 1 1 2 7 . m d \ " : \ " C s O x Z p U a \ " , \ " c h a n g e l o g _ 2 0 2 2 0 2 2 6 . m d \ " : \ " C x S 5 6 D H q \ " , \ " c h a n g e l o g _ 2 0 2 2 0 5 2 8 . m d \ " : \ " B b C W K J r Z \ " , \ " c h a n g e l o g _ 2 0 2 2 0 8 2 7 . m d \ " : \ " m K I E 5 J f z \ " , \ " c h a n g e l o g _ 2 0 2 2 1 1 2 6 . m d \ " : \ " e j K 1 j l 9 1 \ " , \ " c h a n g e l o g _ 2 0 2 3 0 2 2 6 . m d \ " : \ " D A 3 u f Z 0 c \ " , \ " c h a n g e l o g _ 2 0 2 3 0 5 2 8 . m d \ " : \ " D 9 b 6 s N V W \ " , \ " c h a n g e l o g _ 2 0 2 3 0 8 2 7 . m d \ " : \ " C O X 1 l v B Z \ " , \ " c h a n g e l o g _ 2 0 2 3 1 1 2 6 . m d \ " : \ " C _ 9 G u 3 X 6 \ " , \ " c h a n g e l o g _ 2 0 2 4 0 2 2 5 . m d \ " : \ " B H n h J k L K \ " , \ " c h a n g e l o g _ 2 0 2 4 0 5 2 6 . m d \ " : \ " B V - o 3 l F _ \ " , \ " c h a n g e l o g _ 2 0 2 4 0 8 2 5 . m d \ " : \ " C P d _ a 5 8 9 \ " , \ " c h a n g e l o g _ 2 0 2 4 1 1 2 4 . m d \ " : \ " C f U V y Q R e \ " , \ " c a p a b i l i t i e s . m d \ " : \ " - h 9 B L Z p F \ " , \ " c a p a b i l i t i e s _ i n c . m d \ " : \ " C f V c b x N _ \ " , \ " a p i _ d e v e l o p m e n t _ e n v i r o n m e n t . m d \ " : \ " D B O L j n D t \ " , \ " a p i _ d e v e l o p m e n t _ o v e r v i e w . m d \ " : \ " D J C Y P K X o \ " , \ " a p i _ d o c s . m d \ " : \ " q 8 E z z O Y 3 \ " , \ " a p i _ o v e r v i e w . m d \ " : \ " i k C J h J n u \ " , \ " a r m _ d e b u g g i n g . m d \ " : \ " D Z Q j F z 9 i \ " , \ " b r e a k i n g _ c h a n g e s . m d \ " : \ " D x U a C W V B \ " , \ " b r e a k i n g _ c h a n g e s _ h i s t o r y . m d \ " : \ " 3 9 0 B y m 1 u \ " , \ " b r e a k i n g _ c h a n g e s _ i n s t r u c t i o n s . m d \ " : \ " C M d g L Y f 9 \ " , \ " c h i b i o s _ u p g r a d e _ i n s t r u c t i o n s . m d \ " : \ " C 7 S t O V 1 s \ " , \ " c l i . m d \ " : \ " C K h d u D L Q \ " , \ " c l i _ c o m m a n d s . m d \ " : \ " C 5 n 1 - e j j \ " , \ " c l i _ c o n f i g u r a t i o n . m d \ " : \ " X q O 3 N J _ D \ " , \ " c l i _ d e v e l o p m e n t . m d \ " : \ " H R y 9 B c m G \ " , \ " c l i _ t a b _ c o m p l e t e . m d \ " : \ " D 1 O M I P w p \ " , \ " c o d i n g _ c o n v e n t i o n s _ c . m d \ " : \ " B o z x I F _ g \ " , \ " c o d i n g _ c o n v e n t i o n s _ p y t h o n . m d \ " : \ " 1 k a w G u a J \ " , \ " c o m p a t i b l e _ m i c r o c o n t r o l l e r s . m d \ " : \ " D Y 4 P o u k h \ " , \ " c o n f i g _ o p t i o n s . m d \ " : \ " O n 1 g 2 N o J \ " , \ " c o n f i g u r a t o r _ a r c h i t e c t u r e . m d \ " : \ " D 6 b W G Y r O \ " , \ " c o n f i g u r a t o r _ d e f a u l t _ k e y m a p s . m d \ " : \ " D h x _ h N G q \ " , \ " c o n f i g u r a t o r _ s t e p _ b y _ s t e p . m d \ " : \ " C v y p T c m q \ " , \ " c o n f i g u r a t o r _ t r o u b l e s h o o t i n g . m d \ " : \ " B - L x A P M k \ " , \ " c o n t r i b u t i n g . m d \ " : \ " C _ X K I a 1 y \ " , \ " c u s t o m _ m a t r i x . m d \ " : \ " D k x L l d Z 5 \ " , \ " c u s t o m _ q u a n t u m _ f u n c t i o n s . m d \ " : \ " B h e i 0 p 4 N \ " , \ " d a t a _ d r i v e n _ c o n f i g . m d \ " : \ " B Q i J 1 4 m e \ " , \ " d o c u m e n t a t i o n _ b e s t _ p r a c t i c e s . m d \ " : \ " D y K D 6 s i h \ " , \ " d o c u m e n t a t i o n _ t e m p l a t e s . m d \ " : \ " B d - m V 5 H z \ " , \ " d r i v e r _ i n s t a l l a t i o n _ z a d i g . m d \ " : \ " J c Z 6 S L g v \ " , \ " d r i v e r s _ a d c . m d \ " : \ " C v h R M x s 7 \ " , \ " d r i v e r s _ a p a 1 0 2 . m d \ " : \ " D B z 6 6 0 i n \ " , \ " d r i v e r s _ a u d i o . m d \ " : \ " D r i m g q G o \ " , \ " d r i v e r s _ a w 2 0 2 1 6 s . m d \ " : \ " Z e c S T i 1 P \ " , \ " d r i v e r s _ e e p r o m . m d \ " : \ " D G h 7 Y L y 6 \ " , \ " d r i v e r s _ f l a s h . m d \ " : \ " X j r 6 9 q Y 1 \ " , \ " d r i v e r s _ g p i o . m d \ " : \ " D e L M d E E L \ " , \ " d r i v e r s _ i 2 c . m d \ " : \ " B M R o o n x 0 \ " , \ " d r i v e r s _ i s 3 1 f l 3 2 1 8 . m d \ " : \ " C _ B o T O F S \ " , \ " d r i v e r s _ i s 3 1 f l 3 2 3 6 . m d \ " : \ " C m c I o O 2 f \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 2 9 . m d \ " : \ " N S t p a R F c \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 3 1 . m d \ " : \ " 2 B r 2 p c E j \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 3 3 . m d \ " : \ " D u a 4 q p X l \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 3 6 . m d \ " : \ " B - Y Z o 7 1 O \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 3 7 . m d \ " : \ " C n d y Q X k y \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 1 . m d \ " : \ " D m n 6 a I C E \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 2 a . m d \ " : \ " D I j n k a X m \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 3 a . m d \ " : \ " B N C J 3 t P 8 \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 5 . m d \ " : \ " B x n 1 m l O t \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 6 a . m d \ " : \ " x H R _ y h e A \ " , \ " d r i v e r s _ s e r i a l . m d \ " : \ " B t O _ 0 N c w \ " , \ " d r i v e r s _ s n l e d 2 7 3 5 1 . m d \ " : \ " B 1 W 5 R F R F \ " , \ " d r i v e r s _ s p i . m d \ " : \ " D T N 3 n 6 8 a \ " , \ " d r i v e r s _ u a r t . m d \ " : \ " j x J u l I b H \ " , \ " d r i v e r s _ w s 2 8 1 2 . m d \ " : \ " U u K p 7 v l k \ " , \ " e a s y _ m a k e r . m d \ " : \ " C 8 L g N G 9 e \ " , \ " f a q _ b u i l d . m d \ " : \ " C e 7 n 8 G C F \ " , \ " f a q _ d e b u g . m d \ " : \ " C g V p O G A 3 \ " , \ " f a q _ g e n e r a l . m d \ " : \ " C 5 9 X 5 o L Z \ " , \ " f a q _ k e y m a p . m d \ " : \ " z y 3 J - B E y \ " , \ " f a q _ m i s c . m d \ " : \ " B P I g M H Q W \ " , \ " f e a t u r e _ a d v a n c e d _ k e y c o d e s . m d \ " : \ " B n K h _ n O b \ " , \ " f e a t u r e _ c o n v e r t e r s . m d \ " : \ " D Y h k D f a N \ " , \ " f e a t u r e _ d e b o u n c e _ t y p e . m d \ " : \ " B C C Y y k _ P \ " , \ " f e a t u r e _ e e p r o m . m d \ " : \ " D N Q 1 x 9 P A \ " , \ " f e a t u r e _ l a y e r s . m d \ " : \ " R Q M X u 6 l 3 \ " , \ " f e a t u r e _ l a y o u t s . m d \ " : \ " D K b - O g x Y \ " , \ " f e a t u r e _ m a c r o s . m d \ " : \ " B C y m a t k F \ " , \ " f e a t u r e _ u s e r s p a c e . m d \ " : \ " r o f L y 8 s t \ " , \ " f e a t u r e s _ a u d i o . m d \ " : \ " D B f m f m D K \ " , \ " f e a t u r e s _ a u t o _ s h i f t . m d \ " : \ " B F u i Q 7 E E \ " , \ " f e a t u r e s _ a u t o c o r r e c t . m d \ " : \ " D r L n i D B 3 \ " , \ " f e a t u r e s _ b a c k l i g h t . m d \ " : \ " C c _ J b n g p \ " , \ " f e a t u r e s _ b o o t m a g i c . m d \ " : \ " B j t S Z J l L \ " , \ " f e a t u r e s _ c a p s _ w o r d . m d \ " : \ " B w u F _ V h c \ " , \ " f e a t u r e s _ c o m b o . m d \ " : \ " s s a G s A - P \ " , \ " f e a t u r e s _ c o m m a n d . m d \ " : \ " y a 5 i - X F t \ " , \ " f e a t u r e s _ d i g i t i z e r . m d \ " : \ " C O D T 9 W k J \ " , \ " f e a t u r e s _ d i p _ s w i t c h . m d \ " : \ " B a 4 G L 9 7 m \ " , \ " f e a t u r e s _ d y n a m i c _ m a c r o s . m d \ " : \ " D s o U d H C C \ " , \ " f e a t u r e s _ e n c o d e r s . m d \ " : \ " 6 - I j M h t D \ " , \ " f e a t u r e s _ g r a v e _ e s c . m d \ " : \ " B Q R a 2 Z X b \ " , \ " f e a t u r e s _ h a p t i c _ f e e d b a c k . m d \ " : \ " U M P 3 L V Z a \ " , \ " f e a t u r e s _ h d 4
2024-05-30 02:02:10 +00:00
< / body >
< / html >
