diff options
| author | Drashna Jaelre <drashna@live.com> | 2020-05-18 06:05:35 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-18 06:05:35 -0700 |
| commit | d0e0202b272a28d6a1e7f0d059396067bb861272 (patch) | |
| tree | fb1c7fc315cf53846bda0f55985232e71ee9ce82 /docs/feature_rgblight.md | |
| parent | e55d55edc08d5a5ca557e3ff442ca47ccd731067 (diff) | |
| download | qmk_firmware-d0e0202b272a28d6a1e7f0d059396067bb861272.tar.gz qmk_firmware-d0e0202b272a28d6a1e7f0d059396067bb861272.zip | |
Add query functions for RGB Light and RGB Matrix (#8960)
* Add additional query functions for RGBLIGHT
* Add additional query functions for RGB Matrix
* Change names of enable check functions
* Fix macro for rgb matrix takeover of rgblight functions
* Add documentation for rgb_matrix_get_hsv()
* Add *_get_hsv function to rgblight
Diffstat (limited to 'docs/feature_rgblight.md')
| -rw-r--r-- | docs/feature_rgblight.md | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md index 7e54bfef3..7f5c8a36c 100644 --- a/docs/feature_rgblight.md +++ b/docs/feature_rgblight.md | |||
| @@ -376,12 +376,14 @@ rgblight_sethsv(HSV_GREEN, 2); // led 2 | |||
| 376 | |`rgblight_set_layer_state(i, is_on)` |Enable or disable lighting layer `i` based on value of `bool is_on` | | 376 | |`rgblight_set_layer_state(i, is_on)` |Enable or disable lighting layer `i` based on value of `bool is_on` | |
| 377 | 377 | ||
| 378 | #### query | 378 | #### query |
| 379 | |Function |Description | | 379 | |Function |Description | |
| 380 | |-----------------------|-----------------| | 380 | |-----------------------|---------------------------| |
| 381 | |`rgblight_get_mode()` |Get current mode | | 381 | |`rgblight_is_enabled()`|Gets current on/off status | |
| 382 | |`rgblight_get_hue()` |Get current hue | | 382 | |`rgblight_get_mode()` |Gets current mode | |
| 383 | |`rgblight_get_sat()` |Get current sat | | 383 | |`rgblight_get_hue()` |Gets current hue | |
| 384 | |`rgblight_get_val()` |Get current val | | 384 | |`rgblight_get_sat()` |Gets current sat | |
| 385 | |`rgblight_get_val()` |Gets current val | | ||
| 386 | |`rgblight_get_speed()` |Gets current speed | | ||
| 385 | 387 | ||
| 386 | ## Colors | 388 | ## Colors |
| 387 | 389 | ||
