diff options
Diffstat (limited to 'docs/custom_quantum_functions.md')
-rw-r--r-- | docs/custom_quantum_functions.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md index 6eb144af7..e15126c42 100644 --- a/docs/custom_quantum_functions.md +++ b/docs/custom_quantum_functions.md | |||
@@ -319,7 +319,7 @@ This runs code every time that the layers get changed. This can be useful for l | |||
319 | 319 | ||
320 | ### Example `layer_state_set_*` Implementation | 320 | ### Example `layer_state_set_*` Implementation |
321 | 321 | ||
322 | This example shows how to set the [RGB Underglow](feature_rgblight.md) lights based on the layer, using the Planck as an example | 322 | This example shows how to set the [RGB Underglow](feature_rgblight.md) lights based on the layer, using the Planck as an example. |
323 | 323 | ||
324 | ```c | 324 | ```c |
325 | layer_state_t layer_state_set_user(layer_state_t state) { | 325 | layer_state_t layer_state_set_user(layer_state_t state) { |
@@ -343,6 +343,11 @@ layer_state_t layer_state_set_user(layer_state_t state) { | |||
343 | return state; | 343 | return state; |
344 | } | 344 | } |
345 | ``` | 345 | ``` |
346 | |||
347 | Use the `IS_LAYER_ON_STATE(state, layer)` and `IS_LAYER_OFF_STATE(state, layer)` macros to check the status of a particular layer. | ||
348 | |||
349 | Outside of `layer_state_set_*` functions, you can use the `IS_LAYER_ON(layer)` and `IS_LAYER_OFF(layer)` macros to check global layer state. | ||
350 | |||
346 | ### `layer_state_set_*` Function Documentation | 351 | ### `layer_state_set_*` Function Documentation |
347 | 352 | ||
348 | * Keyboard/Revision: `layer_state_t layer_state_set_kb(layer_state_t state)` | 353 | * Keyboard/Revision: `layer_state_t layer_state_set_kb(layer_state_t state)` |