Add LED/RGB Matrix flags API docs (#25673)
This commit is contained in:
Joel Challis
GitHub
parent
0a4c1caf20
commit
6f93a86e6e
3 changed files with 122 additions and 0 deletions
|
|
@ -88,6 +88,8 @@ As mentioned earlier, the center of the keyboard by default is expected to be `{
|
|||
|`QK_LED_MATRIX_BRIGHTNESS_DOWN`|`LM_BRID`|Decrease the brightness level |
|
||||
|`QK_LED_MATRIX_SPEED_UP` |`LM_SPDU`|Increase the animation speed |
|
||||
|`QK_LED_MATRIX_SPEED_DOWN` |`LM_SPDD`|Decrease the animation speed |
|
||||
|`QK_LED_MATRIX_FLAG_NEXT` |`LM_FLGN`|Cycle through flags |
|
||||
|`QK_LED_MATRIX_FLAG_PREVIOUS` |`LM_FLGP`|Cycle through flags in reverse |
|
||||
|
||||
## LED Matrix Effects {#led-matrix-effects}
|
||||
|
||||
|
|
@ -253,6 +255,7 @@ const char* effect_name = led_matrix_get_mode_name(led_matrix_get_mode());
|
|||
#define LED_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set
|
||||
#define LED_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.
|
||||
// If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
|
||||
#define LED_MATRIX_FLAG_STEPS { LED_FLAG_ALL, LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER, LED_FLAG_NONE } // Sets the flags which can be cycled through.
|
||||
```
|
||||
|
||||
## EEPROM storage {#eeprom-storage}
|
||||
|
|
@ -505,6 +508,62 @@ The current effect speed, from 0 to 255.
|
|||
|
||||
---
|
||||
|
||||
### `void led_matrix_set_flags(led_flags_t flags)` {#api-led-matrix-set-flags}
|
||||
|
||||
Set the global effect flags.
|
||||
|
||||
#### Arguments {#api-led-matrix-set-flags-arguments}
|
||||
|
||||
- `led_flags_t flags`
|
||||
The [flags](#flags) value to set.
|
||||
|
||||
---
|
||||
|
||||
### `void led_matrix_set_flags_noeeprom(led_flags_t flags)` {#api-led-matrix-set-flags-noeeprom}
|
||||
|
||||
Set the global effect flags. New state is not written to EEPROM.
|
||||
|
||||
#### Arguments {#api-led-matrix-set-flags-noeeprom-arguments}
|
||||
|
||||
- `led_flags_t flags`
|
||||
The [flags](#flags) value to set.
|
||||
|
||||
---
|
||||
|
||||
### `void led_matrix_flags_step(void)` {#api-led-matrix-flags-step}
|
||||
|
||||
Move to the next flag combination.
|
||||
|
||||
---
|
||||
|
||||
### `void led_matrix_flags_step_noeeprom(void)` {#api-led-matrix-flags-step-noeeprom}
|
||||
|
||||
Move to the next flag combination. New state is not written to EEPROM.
|
||||
|
||||
---
|
||||
|
||||
### `void led_matrix_flags_step_reverse(void)` {#api-led-matrix-flags-step-reverse}
|
||||
|
||||
Move to the previous flag combination.
|
||||
|
||||
---
|
||||
|
||||
### `void led_matrix_flags_step_reverse_noeeprom(void)` {#api-led-matrix-flags-step-reverse-noeeprom}
|
||||
|
||||
Move to the previous flag combination. New state is not written to EEPROM.
|
||||
|
||||
---
|
||||
|
||||
### `uint8_t led_matrix_get_flags(void)` {#api-led-matrix-get-flags}
|
||||
|
||||
Get the current global effect flags.
|
||||
|
||||
#### Return Value {#api-led-matrix-get-flags-return}
|
||||
|
||||
The current effect [flags](#flags).
|
||||
|
||||
---
|
||||
|
||||
### `void led_matrix_reload_from_eeprom(void)` {#api-led-matrix-reload-from-eeprom}
|
||||
|
||||
Reload the effect configuration (enabled, mode and brightness) from EEPROM.
|
||||
|
|
|
|||
|
|
@ -96,6 +96,8 @@ As mentioned earlier, the center of the keyboard by default is expected to be `{
|
|||
|`QK_RGB_MATRIX_VALUE_DOWN` |`RM_VALD`|Decrease the brightness level |
|
||||
|`QK_RGB_MATRIX_SPEED_UP` |`RM_SPDU`|Increase the animation speed |
|
||||
|`QK_RGB_MATRIX_SPEED_DOWN` |`RM_SPDD`|Decrease the animation speed |
|
||||
|`QK_RGB_MATRIX_FLAG_NEXT` |`RM_FLGN`|Cycle through flags |
|
||||
|`QK_RGB_MATRIX_FLAG_PREVIOUS` |`RM_FLGP`|Cycle through flags in reverse |
|
||||
|
||||
## RGB Matrix Effects {#rgb-matrix-effects}
|
||||
|
||||
|
|
@ -409,6 +411,7 @@ const char* effect_name = rgb_matrix_get_mode_name(rgb_matrix_get_mode());
|
|||
#define RGB_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.
|
||||
// If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR
|
||||
#define RGB_TRIGGER_ON_KEYDOWN // Triggers RGB keypress events on key down. This makes RGB control feel more responsive. This may cause RGB to not function properly on some boards
|
||||
#define RGB_MATRIX_FLAG_STEPS { LED_FLAG_ALL, LED_FLAG_KEYLIGHT | LED_FLAG_MODIFIER, LED_FLAG_UNDERGLOW, LED_FLAG_NONE } // Sets the flags which can be cycled through.
|
||||
```
|
||||
|
||||
## EEPROM storage {#eeprom-storage}
|
||||
|
|
@ -852,6 +855,62 @@ The current effect speed, from 0 to 255.
|
|||
|
||||
---
|
||||
|
||||
### `void rgb_matrix_set_flags(led_flags_t flags)` {#api-rgb-matrix-set-flags}
|
||||
|
||||
Set the global effect flags.
|
||||
|
||||
#### Arguments {#api-rgb-matrix-set-flags-arguments}
|
||||
|
||||
- `led_flags_t flags`
|
||||
The [flags](#flags) value to set.
|
||||
|
||||
---
|
||||
|
||||
### `void rgb_matrix_set_flags_noeeprom(led_flags_t flags)` {#api-rgb-matrix-set-flags-noeeprom}
|
||||
|
||||
Set the global effect flags. New state is not written to EEPROM.
|
||||
|
||||
#### Arguments {#api-rgb-matrix-set-flags-noeeprom-arguments}
|
||||
|
||||
- `led_flags_t flags`
|
||||
The [flags](#flags) value to set.
|
||||
|
||||
---
|
||||
|
||||
### `void rgb_matrix_flags_step(void)` {#api-rgb-matrix-flags-step}
|
||||
|
||||
Move to the next flag combination.
|
||||
|
||||
---
|
||||
|
||||
### `void rgb_matrix_flags_step_noeeprom(void)` {#api-rgb-matrix-flags-step-noeeprom}
|
||||
|
||||
Move to the next flag combination. New state is not written to EEPROM.
|
||||
|
||||
---
|
||||
|
||||
### `void rgb_matrix_flags_step_reverse(void)` {#api-rgb-matrix-flags-step-reverse}
|
||||
|
||||
Move to the previous flag combination.
|
||||
|
||||
---
|
||||
|
||||
### `void rgb_matrix_flags_step_reverse_noeeprom(void)` {#api-rgb-matrix-flags-step-reverse-noeeprom}
|
||||
|
||||
Move to the previous flag combination. New state is not written to EEPROM.
|
||||
|
||||
---
|
||||
|
||||
### `uint8_t rgb_matrix_get_flags(void)` {#api-rgb-matrix-get-flags}
|
||||
|
||||
Get the current global effect flags.
|
||||
|
||||
#### Return Value {#api-rgb-matrix-get-flags-return}
|
||||
|
||||
The current effect [flags](#flags).
|
||||
|
||||
---
|
||||
|
||||
### `void rgb_matrix_sethsv(uint8_t h, uint8_t s, uint8_t v)` {#api-rgb-matrix-sethsv}
|
||||
|
||||
Set the global effect hue, saturation, and value (brightness).
|
||||
|
|
|
|||
|
|
@ -433,6 +433,8 @@ See also: [LED Matrix](features/led_matrix)
|
|||
|`QK_LED_MATRIX_BRIGHTNESS_DOWN`|`LM_BRID`|Decrease the brightness level |
|
||||
|`QK_LED_MATRIX_SPEED_UP` |`LM_SPDU`|Increase the animation speed |
|
||||
|`QK_LED_MATRIX_SPEED_DOWN` |`LM_SPDD`|Decrease the animation speed |
|
||||
|`QK_LED_MATRIX_FLAG_NEXT` |`LM_FLGN`|Cycle through flags |
|
||||
|`QK_LED_MATRIX_FLAG_PREVIOUS` |`LM_FLGP`|Cycle through flags in reverse |
|
||||
|
||||
## Magic Keycodes {#magic-keycodes}
|
||||
|
||||
|
|
@ -783,6 +785,8 @@ See also: [RGB Matrix](features/rgb_matrix)
|
|||
|`QK_RGB_MATRIX_VALUE_DOWN` |`RM_VALD`|Decrease the brightness level |
|
||||
|`QK_RGB_MATRIX_SPEED_UP` |`RM_SPDU`|Increase the animation speed |
|
||||
|`QK_RGB_MATRIX_SPEED_DOWN` |`RM_SPDD`|Decrease the animation speed |
|
||||
|`QK_RGB_MATRIX_FLAG_NEXT` |`RM_FLGN`|Cycle through flags |
|
||||
|`QK_RGB_MATRIX_FLAG_PREVIOUS` |`RM_FLGP`|Cycle through flags in reverse |
|
||||
|
||||
## US ANSI Shifted Symbols {#us-ansi-shifted-symbols}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue