summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2020-05-18 06:05:35 -0700
committerGitHub <noreply@github.com>2020-05-18 06:05:35 -0700
commitd0e0202b272a28d6a1e7f0d059396067bb861272 (patch)
treefb1c7fc315cf53846bda0f55985232e71ee9ce82 /docs
parente55d55edc08d5a5ca557e3ff442ca47ccd731067 (diff)
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')
-rw-r--r--docs/feature_rgb_matrix.md16
-rw-r--r--docs/feature_rgblight.md14
2 files changed, 18 insertions, 12 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index 2cec55ee77..15057827c8 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -437,12 +437,16 @@ Where `28` is an unused index from `eeconfig.h`.
|`rgb_matrix_sethsv_noeeprom(h, s, v)` |Set LEDs to the given HSV value where `h`/`s`/`v` are between 0 and 255 (not written to EEPROM) |
### Query Current Status :id=query-current-status
-|Function |Description |
-|-----------------------|-----------------|
-|`rgb_matrix_get_mode()` |Get current mode |
-|`rgb_matrix_get_hue()` |Get current hue |
-|`rgb_matrix_get_sat()` |Get current sat |
-|`rgb_matrix_get_val()` |Get current val |
+|Function |Description |
+|---------------------------------|---------------------------|
+|`rgb_matrix_is_enabled()` |Gets current on/off status |
+|`rgb_matrix_get_mode()` |Gets current mode |
+|`rgb_matrix_get_hue()` |Gets current hue |
+|`rgb_matrix_get_sat()` |Gets current sat |
+|`rgb_matrix_get_val()` |Gets current val |
+|`rgb_matrix_get_hsv()` |Gets hue, sat, and val and returns a [`HSV` structure](https://github.com/qmk/qmk_firmware/blob/7ba6456c0b2e041bb9f97dbed265c5b8b4b12192/quantum/color.h#L56-L61)|
+|`rgb_matrix_get_speed()` |Gets current speed |
+|`rgb_matrix_get_suspend_state()` |Gets current suspend state |
## Callbacks :id=callbacks
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 7e54bfef3c..7f5c8a36c1 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -376,12 +376,14 @@ rgblight_sethsv(HSV_GREEN, 2); // led 2
|`rgblight_set_layer_state(i, is_on)` |Enable or disable lighting layer `i` based on value of `bool is_on` |
#### query
-|Function |Description |
-|-----------------------|-----------------|
-|`rgblight_get_mode()` |Get current mode |
-|`rgblight_get_hue()` |Get current hue |
-|`rgblight_get_sat()` |Get current sat |
-|`rgblight_get_val()` |Get current val |
+|Function |Description |
+|-----------------------|---------------------------|
+|`rgblight_is_enabled()`|Gets current on/off status |
+|`rgblight_get_mode()` |Gets current mode |
+|`rgblight_get_hue()` |Gets current hue |
+|`rgblight_get_sat()` |Gets current sat |
+|`rgblight_get_val()` |Gets current val |
+|`rgblight_get_speed()` |Gets current speed |
## Colors