diff options
| author | Drashna Jaelre <drashna@live.com> | 2020-08-05 13:29:04 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-05 13:29:04 -0700 |
| commit | 4c14b11fc79e51521b6e53453862252b806a5c02 (patch) | |
| tree | 113a2970b51d2b58ff7435e36161dcb354d5b835 /docs | |
| parent | 3df52050c12cd5e6286664672efc6f43849d935d (diff) | |
Add Indicator flag for RGB Matrix (#9933)
* Add Indicator flag for RGB Matrix
This adds a new flag for the RGB Matrix feature that lets you specify if the LED is an indicator LED, to be used to indicate the system state of the keyboard (eg caps/num/etc lock status, layer indication, modifer status, etc).
* Better formatting of table
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_rgb_matrix.md | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md index 9604bdcc89..2cde3ec569 100644 --- a/docs/feature_rgb_matrix.md +++ b/docs/feature_rgb_matrix.md @@ -159,15 +159,16 @@ As mentioned earlier, the center of the keyboard by default is expected to be `{ ## Flags :id=flags -|Define |Description | -|------------------------------------|-------------------------------------------| -|`#define HAS_FLAGS(bits, flags)` |Returns true if `bits` has all `flags` set.| -|`#define HAS_ANY_FLAGS(bits, flags)`|Returns true if `bits` has any `flags` set.| -|`#define LED_FLAG_NONE 0x00` |If this LED has no flags. | -|`#define LED_FLAG_ALL 0xFF` |If this LED has all flags. | -|`#define LED_FLAG_MODIFIER 0x01` |If the Key for this LED is a modifier. | -|`#define LED_FLAG_UNDERGLOW 0x02` |If the LED is for underglow. | -|`#define LED_FLAG_KEYLIGHT 0x04` |If the LED is for key backlight. | +|Define |Value |Description | +|----------------------------|------|-------------------------------------------------| +|`HAS_FLAGS(bits, flags)` |*n/a* |Evaluates to `true` if `bits` has all `flags` set| +|`HAS_ANY_FLAGS(bits, flags)`|*n/a* |Evaluates to `true` if `bits` has any `flags` set| +|`LED_FLAG_NONE` |`0x00`|If this LED has no flags | +|`LED_FLAG_ALL` |`0xFF`|If this LED has all flags | +|`LED_FLAG_MODIFIER` |`0x01`|If the LED is on a modifier key | +|`LED_FLAG_UNDERGLOW` |`0x02`|If the LED is for underglow | +|`LED_FLAG_KEYLIGHT` |`0x04`|If the LED is for key backlight | +|`LED_FLAG_INDICATOR` |`0x08`|If the LED is for keyboard state indication | ## Keycodes :id=keycodes |