aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_rgb_matrix.md
diff options
context:
space:
mode:
authorErovia <Erovia@users.noreply.github.com>2019-04-22 17:26:41 +0200
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-04-22 08:26:41 -0700
commit066818f5f9cbee4ade1ea94ee167ee2df7d9e559 (patch)
treee9276a47f8f421211e54c5a1685d69ac2f6a908e /docs/feature_rgb_matrix.md
parentc7583d181a2cae24af60efa93caa3d662e5d48f4 (diff)
downloadqmk_firmware-066818f5f9cbee4ade1ea94ee167ee2df7d9e559.tar.gz
qmk_firmware-066818f5f9cbee4ade1ea94ee167ee2df7d9e559.zip
Define RGB colors (#5300)
* Define RGB colors Define RGB colors and pass them to the rgblight functions, instead of defining multiple macros. * Add new color definitions support for RGB Matrix * Add/clarify info about new color definitions in Docs * Add deprecation warning banner to rgblight_list.h
Diffstat (limited to 'docs/feature_rgb_matrix.md')
-rw-r--r--docs/feature_rgb_matrix.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index acef4717d..5309e749c 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -236,6 +236,35 @@ void rgb_matrix_indicators_kb(void) {
236 236
237A similar function works in the keymap as `rgb_matrix_indicators_user`. 237A similar function works in the keymap as `rgb_matrix_indicators_user`.
238 238
239
240## Colors
241
242These are shorthands to popular colors. The `RGB` ones can be passed to the `setrgb` functions, while the `HSV` ones to the `sethsv` functions.
243
244|RGB |HSV |
245|-------------------|-------------------|
246|`RGB_WHITE` |`HSV_WHITE` |
247|`RGB_RED` |`HSV_RED` |
248|`RGB_CORAL` |`HSV_CORAL` |
249|`RGB_ORANGE` |`HSV_ORANGE` |
250|`RGB_GOLDENROD` |`HSV_GOLDENROD` |
251|`RGB_GOLD` |`HSV_GOLD` |
252|`RGB_YELLOW` |`HSV_YELLOW` |
253|`RGB_CHARTREUSE` |`HSV_CHARTREUSE` |
254|`RGB_GREEN` |`HSV_GREEN` |
255|`RGB_SPRINGGREEN` |`HSV_SPRINGGREEN` |
256|`RGB_TURQUOISE` |`HSV_TURQUOISE` |
257|`RGB_TEAL` |`HSV_TEAL` |
258|`RGB_CYAN` |`HSV_CYAN` |
259|`RGB_AZURE` |`HSV_AZURE` |
260|`RGB_BLUE` |`HSV_BLUE` |
261|`RGB_PURPLE` |`HSV_PURPLE` |
262|`RGB_MAGENTA` |`HSV_MAGENTA` |
263|`RGB_PINK` |`HSV_PINK` |
264
265These are defined in [`rgblight_list.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight_list.h). Feel free to add to this list!
266
267
239## Additional `config.h` Options 268## Additional `config.h` Options
240 269
241```C 270```C