diff options
Diffstat (limited to 'docs/feature_layers.md')
| -rw-r--r-- | docs/feature_layers.md | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/docs/feature_layers.md b/docs/feature_layers.md index d3ee747e6..3f62cfc80 100644 --- a/docs/feature_layers.md +++ b/docs/feature_layers.md | |||
| @@ -74,10 +74,9 @@ There are a number of functions (and variables) related to how you can use or ma | |||
| 74 | | [`update_tri_layer(x, y, z)`](ref_functions.md#update_tri_layerx-y-z) | Checks if layers `x` and `y` are both on, and sets `z` based on that (on if both on, otherwise off). | | 74 | | [`update_tri_layer(x, y, z)`](ref_functions.md#update_tri_layerx-y-z) | Checks if layers `x` and `y` are both on, and sets `z` based on that (on if both on, otherwise off). | |
| 75 | | [`update_tri_layer_state(state, x, y, z)`](ref_functions.md#update_tri_layer_statestate-x-y-z) | Does the same as `update_tri_layer(x, y, z)`, but from `layer_state_set_*` functions. | | 75 | | [`update_tri_layer_state(state, x, y, z)`](ref_functions.md#update_tri_layer_statestate-x-y-z) | Does the same as `update_tri_layer(x, y, z)`, but from `layer_state_set_*` functions. | |
| 76 | 76 | ||
| 77 | In addition to the functions that you can call, there are a number of callback functions that get called every time the layer changes. This passes the layer state to the function, where it can be read or modified. | ||
| 77 | 78 | ||
| 78 | In additional to the functions that you can call, there are a number of callback functions that get called every time the layer changes. This passed the layer state to the function, which can be read or modified. | 79 | |Callback |Description | |
| 79 | |||
| 80 | |Callbacks |Description | | ||
| 81 | |-----------------------------------------------------|----------------------------------------------------------------------------------------| | 80 | |-----------------------------------------------------|----------------------------------------------------------------------------------------| |
| 82 | | `layer_state_set_kb(layer_state_t state)` | Callback for layer functions, for keyboard. | | 81 | | `layer_state_set_kb(layer_state_t state)` | Callback for layer functions, for keyboard. | |
| 83 | | `layer_state_set_user(layer_state_t state)` | Callback for layer functions, for users. | | 82 | | `layer_state_set_user(layer_state_t state)` | Callback for layer functions, for users. | |
| @@ -86,9 +85,9 @@ In additional to the functions that you can call, there are a number of callback | |||
| 86 | 85 | ||
| 87 | ?> For additional details on how you can use these callbacks, check out the [Layer Change Code](custom_quantum_functions.md#layer-change-code) document. | 86 | ?> For additional details on how you can use these callbacks, check out the [Layer Change Code](custom_quantum_functions.md#layer-change-code) document. |
| 88 | 87 | ||
| 89 | |Check functions |Description | | 88 | It is also possible to check the state of a particular layer using the following functions and macros. |
| 90 | |-------------------------------------------|------------------------------------------------------------------------------| | ||
| 91 | | `layer_state_cmp(cmp_layer_state, layer)` | This checks the `cmp_layer_state` to see if the specific `layer` is enabled. This is meant for use with the layer callbacks. | | ||
| 92 | | `layer_state_is(layer)` | This checks the layer state to see if the specific `layer` is enabled. (calls `layer_state_cmp` for the global layer state). | | ||
| 93 | 89 | ||
| 94 | !> There is `IS_LAYER_ON(layer)` as well, however the `layer_state_cmp` function has some additional handling to ensure that on layer 0 that it returns the correct value. Otherwise, if you check to see if layer 0 is on, you may get an incorrect value returned. | 90 | |Function |Description |Aliases |
| 91 | |---------------------------------|-------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------| | ||
| 92 | | `layer_state_is(layer)` | Checks if the specified `layer` is enabled globally. | `IS_LAYER_ON(layer)`, `IS_LAYER_OFF(layer)` | | ||
| 93 | | `layer_state_cmp(state, layer)` | Checks `state` to see if the specified `layer` is enabled. Intended for use in layer callbacks. | `IS_LAYER_ON_STATE(state, layer)`, `IS_LAYER_OFF_STATE(state, layer)` | | ||