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" >
2024-05-31 00:38:24 +00:00
< link rel = "preload stylesheet" href = "/assets/style.No8zk9aC.css" as = "style" >
2024-05-30 02:02:10 +00:00
2024-06-12 00:51:54 +00:00
< script type = "module" src = "/assets/app.D828SKzM.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 = "" >
< link rel = "modulepreload" href = "/assets/chunks/framework.DyMmIvSC.js" >
2024-06-12 00:51:54 +00:00
< link rel = "modulepreload" href = "/assets/chunks/theme.D-bb5p4x.js" >
2024-06-02 02:43:43 +00:00
< link rel = "modulepreload" href = "/assets/feature_layers.md.8GwBUTZN.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-06-02 02:43:43 +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
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-06-02 02:43:43 +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 > <!-- [ --> <!-- ] --> <!-- --> < 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 = "/one_shot_keys" data-v-09de1c0f > <!-- [ --> < span class = "desc" data-v-09de1c0f > Next page< / span > < span class = "title" data-v-09de1c0f > One Shot Keys< / span > <!-- ] --> < / a > < / div > < / nav > < / footer > <!-- [ --> <!-- ] --> < / div > < / div > < / div > <!-- [ --> <!-- ] --> < / div > < / div > <!-- --> <!-- [ --> <!-- ] --> < / div > < / div >
2024-06-12 00:51:54 +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 2 0 0 5 3 0 . m d \ " : \ " D k - v R p T Q \ " , \ " c h a n g e l o g _ 2 0 2 0 0 2 2 9 . m d \ " : \ " D N s o w w M 1 \ " , \ " c h a n g e l o g _ 2 0 2 0 0 8 2 9 . m d \ " : \ " C o q r O f f n \ " , \ " c h a n g e l o g _ 2 0 2 1 0 5 2 9 . m d \ " : \ " C R 1 Y N f Z X \ " , \ " c l i _ c o n f i g u r a t i o n . m d \ " : \ " C G S B 1 2 8 P \ " , \ " c o n f i g _ o p t i o n s . m d \ " : \ " D v M e q l p B \ " , \ " c l i . m d \ " : \ " B L z A d A 6 l \ " , \ " 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 E F T v T l S \ " , \ " c l i _ c o m m a n d s . m d \ " : \ " D G x - q N i E \ " , \ " d r i v e r s _ s e r i a l . m d \ " : \ " q x j y t V d M \ " , \ " d r i v e r s _ s p i . m d \ " : \ " t J V e I T 7 e \ " , \ " d r i v e r s _ u a r t . m d \ " : \ " B N B s - m 3 h \ " , \ " d r i v e r s _ w s 2 8 1 2 . m d \ " : \ " D 9 E 3 W b - Y \ " , \ " c h a n g e l o g _ 2 0 2 3 0 8 2 7 . m d \ " : \ " N S P h m B 6 l \ " , \ " c h a n g e l o g _ 2 0 2 3 1 1 2 6 . m d \ " : \ " D 2 O k 5 Q A f \ " , \ " a p i _ o v e r v i e w . m d \ " : \ " 0 F P a U s M b \ " , \ " 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 \ " : \ " C X 9 - B A C t \ " , \ " b r e a k i n g _ c h a n g e s _ h i s t o r y . m d \ " : \ " C k z d D 6 x 8 \ " , \ " 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 \ " : \ " B A j I G e J b \ " , \ " n e w b s _ t e s t i n g _ d e b u g g i n g . m d \ " : \ " D - c 7 G l e _ \ " , \ " f e a t u r e s _ s e q u e n c e r . m d \ " : \ " D k g q N C s Q \ " , \ " d r i v e r s _ a p a 1 0 2 . m d \ " : \ " Q b - K X R p F \ " , \ " o n e _ s h o t _ k e y s . m d \ " : \ " Q R 0 9 r S b - \ " , \ " a r m _ d e b u g g i n g . m d \ " : \ " B H - H 2 U k z \ " , \ " f e a t u r e _ u s e r s p a c e . m d \ " : \ " B s m Y 9 y W w \ " , \ " f e a t u r e s _ u n i c o d e . m d \ " : \ " C s O N - f J H \ " , \ " c o d i n g _ c o n v e n t i o n s _ c . m d \ " : \ " D d r p X B E h \ " , \ " 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 \ " : \ " B 5 d M t L 5 R \ " , \ " c h a n g e l o g _ 2 0 2 0 1 1 2 8 . m d \ " : \ " 7 X X L 0 2 B n \ " , \ " c h a n g e l o g _ 2 0 2 1 0 8 2 8 . m d \ " : \ " D N b H I u u M \ " , \ " c l i _ d e v e l o p m e n t . m d \ " : \ " 3 x F A 2 O v S \ " , \ " f a q _ k e y m a p . m d \ " : \ " B s E m E Z T o \ " , \ " o t h e r _ e c l i p s e . m d \ " : \ " C - z q y J O 9 \ " , \ " d r i v e r s _ g p i o . m d \ " : \ " C 5 P v y J V h \ " , \ " o t h e r _ v s c o d e . m d \ " : \ " D i 3 v O y S R \ " , \ " c h a n g e l o g _ 2 0 2 2 0 2 2 6 . m d \ " : \ " B W O 5 r _ e c \ " , \ " c h a n g e l o g _ 2 0 2 4 0 5 2 6 . m d \ " : \ " i G L F D 0 S P \ " , \ " f e a t u r e s _ s p a c e _ c a d e t . m d \ " : \ " D m N f Y R V J \ " , \ " f a q _ m i s c . m d \ " : \ " q G r h O T u 4 \ " , \ " f e a t u r e s _ s t e n o g r a p h y . m d \ " : \ " B b _ I h U G l \ " , \ " f e a t u r e s _ s t 7 5 6 5 . m d \ " : \ " M o a j N u r J \ " , \ " f e a t u r e s _ p s 2 _ m o u s e . m d \ " : \ " C L _ p A 9 s k \ " , \ " f e a t u r e s _ s p l i t _ k e y b o a r d . m d \ " : \ " m M T U z I 5 n \ " , \ " f e a t u r e _ e e p r o m . m d \ " : \ " a 0 e o T Z m 7 \ " , \ " c h a n g e l o g _ 2 0 2 2 0 8 2 7 . m d \ " : \ " D j P t h q D k \ " , \ " d r i v e r s _ a u d i o . m d \ " : \ " m q a z 6 p 5 N \ " , \ " d r i v e r s _ e e p r o m . m d \ " : \ " B _ 6 s o q a r \ " , \ " d r i v e r s _ f l a s h . m d \ " : \ " D h W c H p 8 S \ " , \ " c h a n g e l o g _ 2 0 2 2 1 1 2 6 . m d \ " : \ " D p b r n X e C \ " , \ " d r i v e r s _ i 2 c . m d \ " : \ " C u j 8 7 r e B \ " , \ " 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 c e y 4 n t L \ " , \ " f e a t u r e s _ w p m . m d \ " : \ " B Y f - X c 1 H \ " , \ " f l a s h i n g . m d \ " : \ " B S Z F 2 R C y \ " , \ " c o n f i g u r a t o r _ s t e p _ b y _ s t e p . m d \ " : \ " G v m P t S c T \ " , \ " f a q _ b u i l d . m d \ " : \ " D L _ W e z A 1 \ " , \ " a p i _ d o c s . m d \ " : \ " C R o D 6 C b L \ " , \ " p l a t f o r m d e v _ r p 2 0 4 0 . m d \ " : \ " C Y K Y M D f c \ " , \ " p o r t i n g _ y o u r _ k e y b o a r d _ t o _ q m k . m d \ " : \ " C G l G d F j 4 \ " , \ " f a q _ g e n e r a l . m d \ " : \ " B C 3 p F w 4 U \ " , \ " d a t a _ d r i v e n _ c o n f i g . m d \ " : \ " B v L Q 7 P 2 0 \ " , \ " c u s t o m _ m a t r i x . m d \ " : \ " D M n R w _ 5 l \ " , \ " f a q _ d e b u g . m d \ " : \ " D u T h V a l w \ " , \ " p r _ c h e c k l i s t . m d \ " : \ " B n r D X G 2 G \ " , \ " 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 h k u m 0 w D \ " , \ " d r i v e r s _ a d c . m d \ " : \ " D z U 8 t x f 8 \ " , \ " p l a t f o r m d e v _ s e l e c t i n g _ a r m _ m c u . m d \ " : \ " a F 4 D U s v b \ " , \ " g e t t i n g _ s t a r t e d _ d o c k e r . m d \ " : \ " m z 6 H E 4 B l \ " , \ " f e a t u r e s _ c a p s _ w o r d . m d \ " : \ " B D Q G M 0 - x \ " , \ " 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 x G L P T 8 G \ " , \ " f e a t u r e s _ s w a p _ h a n d s . m d \ " : \ " D O h g G Q f 9 \ " , \ " f e a t u r e s _ d i p _ s w i t c h . m d \ " : \ " D t B O d c 9 8 \ " , \ " f e a t u r e s _ t r i _ l a y e r . m d \ " : \ " D d n B V i n w \ " , \ " q u a n t u m _ p a i n t e r _ l v g l . m d \ " : \ " D o b N b S g A \ " , \ " f e a t u r e _ d e b o u n c e _ t y p e . m d \ " : \ " C U r S p 0 I y \ " , \ " f e a t u r e s _ d y n a m i c _ m a c r o s . m d \ " : \ " C r J 1 v h B A \ " , \ " q u a n t u m _ p a i n t e r _ r l e . m d \ " : \ " B 0 7 V 3 m - n \ " , \ " f e a t u r e s _ e n c o d e r s . m d \ " : \ " B 2 S X 3 h G 2 \ " , \ " f e a t u r e s _ t a p _ d a n c e . m d \ " : \ " C K L V p n I n \ " , \ " g e t t i n g _ s t a r t e d _ m a k e _ g u i d e . m d \ " : \ " B j U u E n S h \ " , \ " r e f e r e n c e _ g l o s s a r y . m d \ " : \ " C X M u x T o T \ " , \ " f e a t u r e s _ g r a v e _ e s c . m d \ " : \ " m U N E j U Y S \ " , \ " r e f e r e n c e _ k e y m a p _ e x t r a s . m d \ " : \ " - n _ b L m 7 8 \ " , \ " 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 \ " : \ " B 3 v 8 d l H d \ " , \ " f e a t u r e _ l a y o u t s . m d \ " : \ " q c y 8 h N M O \ " , \ " c h a n g e l o g _ 2 0 2 3 0 5 2 8 . m d \ " : \ " n X 9 R 4 8 z P \ " , \ " c h a n g e l o g _ 2 0 2 4 0 2 2 5 . m d \ " : \ " B 4 - W r X j 6 \ " , \ " f e a t u r e s _ a u d i o . m d \ " : \ " D W N Y t e 3 W \ " , \ " c o n t r i b u t i n g . m d \ " : \ " D L s p 4 v S A \ " , \ " f e a t u r e s _ h d 4 4 7 8 0 . m d \ " : \ " 1 5 K 4 0 o _ e \ " , \ " f e a t u r e s _ k e y _ l o c k . m d \ " : \ " I j F q 9 d Y s \ " , \ " f e a t u r e s _ k e y _ o v e r r i d e s . m d \ " : \ " r V T P 6 k n 9 \ " , \ " f e a t u r e s _ l e a d e r _ k e y . m d \ " : \ " D B Q T n B R h \ " , \ " f e a t u r e s _ l e d _ i n d i c a t o r s . m d \ " : \ " C C Z h j H e 9 \ " , \ " f e a t u r e s _ m o u s e _ k e y s . m d \ " : \ " C 3 P 3 p Y u E \ " , \ " f e a t u r e s _ m i d i . m d \ " : \ " u 3 t H P t e B \ " , \ " f e a t u r e s _ l e d _ m a t r i x . m d \ " : \ " D V 3 1 n H H - \ " , \ " f e a t u r e s _ r e p e a t _ k e y . m d \ " : \ " C 3 e W D U W n \ " , \ " f e a t u r e s _ r a w h i d . m d \ " : \ " b K K G 3 K C a \ " , \ " f e a t u r e s _ o l e d _ d r i v e r . m d \ " : \ " D 9 w J V d L 1 \ " , \ " 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 \ " : \ " B t E j e P a Z \ " , \ " g e t t i n g _ s t a r t e d _ g i t h u b . m d \ " : \ " O Y q 7 I T 7 B \ " , \ " g e t t i n g _ s t a r t e d _ i n t r o d u c t i o n . m d \ " : \ " B O J r e q S s \ " , \ " f e a t u r e s _ s e c u r e . m d \ " : \ " B X 7 j F v W 5 \ " , \ " f e a t u r e s _ r g b l i g h t . m d \ " : \ " D e h Q i k i L \ " , \ " h a r d w a r e _ d r i v e r s . m d \ " : \ " B U n x 4 8 D 9 \ " , \ " h
2024-05-30 02:02:10 +00:00
< / body >
< / html >
