aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/custom_quantum_functions.md12
-rw-r--r--docs/feature_oled_driver.md2
-rw-r--r--docs/feature_userspace.md4
-rw-r--r--docs/ref_functions.md4
4 files changed, 11 insertions, 11 deletions
diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md
index 7be82c650..839d49ca0 100644
--- a/docs/custom_quantum_functions.md
+++ b/docs/custom_quantum_functions.md
@@ -297,8 +297,8 @@ This runs code every time that the layers get changed. This can be useful for l
297This example shows how to set the [RGB Underglow](feature_rgblight.md) lights based on the layer, using the Planck as an example 297This example shows how to set the [RGB Underglow](feature_rgblight.md) lights based on the layer, using the Planck as an example
298 298
299```c 299```c
300uint32_t layer_state_set_user(uint32_t state) { 300layer_state_t layer_state_set_user(layer_state_t state) {
301 switch (biton32(state)) { 301 switch (get_highest_layer(state)) {
302 case _RAISE: 302 case _RAISE:
303 rgblight_setrgb (0x00, 0x00, 0xFF); 303 rgblight_setrgb (0x00, 0x00, 0xFF);
304 break; 304 break;
@@ -320,8 +320,8 @@ uint32_t layer_state_set_user(uint32_t state) {
320``` 320```
321### `layer_state_set_*` Function Documentation 321### `layer_state_set_*` Function Documentation
322 322
323* Keyboard/Revision: `uint32_t layer_state_set_kb(uint32_t state)` 323* Keyboard/Revision: `layer_state_t layer_state_set_kb(layer_state_t state)`
324* Keymap: `uint32_t layer_state_set_user(uint32_t state)` 324* Keymap: `layer_state_t layer_state_set_user(layer_state_t state)`
325 325
326 326
327The `state` is the bitmask of the active layers, as explained in the [Keymap Overview](keymap.md#keymap-layer-status) 327The `state` is the bitmask of the active layers, as explained in the [Keymap Overview](keymap.md#keymap-layer-status)
@@ -377,8 +377,8 @@ void keyboard_post_init_user(void) {
377The above function will use the EEPROM config immediately after reading it, to set the default layer's RGB color. The "raw" value of it is converted in a usable structure based on the "union" that you created above. 377The above function will use the EEPROM config immediately after reading it, to set the default layer's RGB color. The "raw" value of it is converted in a usable structure based on the "union" that you created above.
378 378
379```c 379```c
380uint32_t layer_state_set_user(uint32_t state) { 380layer_state_t layer_state_set_user(layer_state_t state) {
381 switch (biton32(state)) { 381 switch (get_highest_layer(state)) {
382 case _RAISE: 382 case _RAISE:
383 if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_magenta(); rgblight_mode_noeeprom(1); } 383 if (user_config.rgb_layer_change) { rgblight_sethsv_noeeprom_magenta(); rgblight_mode_noeeprom(1); }
384 break; 384 break;
diff --git a/docs/feature_oled_driver.md b/docs/feature_oled_driver.md
index 503e43828..9d19beedb 100644
--- a/docs/feature_oled_driver.md
+++ b/docs/feature_oled_driver.md
@@ -31,7 +31,7 @@ This enables the feature and the `OLED_DRIVER_ENABLE` define. Then in your `keym
31void oled_task_user(void) { 31void oled_task_user(void) {
32 // Host Keyboard Layer Status 32 // Host Keyboard Layer Status
33 oled_write_P(PSTR("Layer: "), false); 33 oled_write_P(PSTR("Layer: "), false);
34 switch (biton32(layer_state)) { 34 switch (get_highest_layer(layer_state)) {
35 case _QWERTY: 35 case _QWERTY:
36 oled_write_P(PSTR("Default\n"), false); 36 oled_write_P(PSTR("Default\n"), false);
37 break; 37 break;
diff --git a/docs/feature_userspace.md b/docs/feature_userspace.md
index 2f119c8bd..1cc8ca742 100644
--- a/docs/feature_userspace.md
+++ b/docs/feature_userspace.md
@@ -115,11 +115,11 @@ For instance, let's look at the `layer_state_set_user()` function. You can enab
115In your `<name.c>` file, you'd want to add this: 115In your `<name.c>` file, you'd want to add this:
116```c 116```c
117__attribute__ ((weak)) 117__attribute__ ((weak))
118uint32_t layer_state_set_keymap (uint32_t state) { 118layer_state_t layer_state_set_keymap (layer_state_t state) {
119 return state; 119 return state;
120} 120}
121 121
122uint32_t layer_state_set_user (uint32_t state) { 122layer_state_t layer_state_set_user (layer_state_t state) {
123 state = update_tri_layer_state(state, 2, 3, 5); 123 state = update_tri_layer_state(state, 2, 3, 5);
124 return layer_state_set_keymap (state); 124 return layer_state_set_keymap (state);
125} 125}
diff --git a/docs/ref_functions.md b/docs/ref_functions.md
index 174d9a95a..1ac83cec4 100644
--- a/docs/ref_functions.md
+++ b/docs/ref_functions.md
@@ -50,7 +50,7 @@ The caveat to this method is that you cannot access the `z` layer without having
50#### Example 50#### Example
51 51
52```c 52```c
53uint32_t layer_state_set_user(uint32_t state) { 53layer_state_t layer_state_set_user(layer_state_t state) {
54 return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST); 54 return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
55} 55}
56``` 56```
@@ -58,7 +58,7 @@ uint32_t layer_state_set_user(uint32_t state) {
58Alternatively, you don't have to immediately "return" the value. This is useful if you want to add multiple tri layers, or if you want to add additional effects. 58Alternatively, you don't have to immediately "return" the value. This is useful if you want to add multiple tri layers, or if you want to add additional effects.
59 59
60```c 60```c
61uint32_t layer_state_set_user(uint32_t state) { 61layer_state_t layer_state_set_user(layer_state_t state) {
62 state = update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST); 62 state = update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
63 state = update_tri_layer_state(state, _RAISE, _SYMB, _SPECIAL); 63 state = update_tri_layer_state(state, _RAISE, _SYMB, _SPECIAL);
64 return state; 64 return state;