aboutsummaryrefslogtreecommitdiff
path: root/docs/custom_quantum_functions.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2019-08-21 17:07:49 -0700
committerGitHub <noreply@github.com>2019-08-21 17:07:49 -0700
commitb62e160a8950f451b08f1fee0109e60a58c5ddaa (patch)
tree897619679d73edd3a5c62bc528f1bfaaf974b96b /docs/custom_quantum_functions.md
parentd534c72a544454132b3c6c05af85c821f6a93d65 (diff)
downloadqmk_firmware-b62e160a8950f451b08f1fee0109e60a58c5ddaa.tar.gz
qmk_firmware-b62e160a8950f451b08f1fee0109e60a58c5ddaa.zip
Additional changes for Layer State typedef compatibility (#5906)
* Additional changes for Layer State typedef compatibility * Replace biton32 with get_highest_layer in docs * Change additional layer structure code * Fix uGFX reference issue * Remove dynamic_keymap check * Where did all these extra spaces come from Co-Authored-By: fauxpark <fauxpark@gmail.com>
Diffstat (limited to 'docs/custom_quantum_functions.md')
-rw-r--r--docs/custom_quantum_functions.md12
1 files changed, 6 insertions, 6 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;