aboutsummaryrefslogtreecommitdiff
path: root/docs/feature_rgblight.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/feature_rgblight.md')
-rw-r--r--docs/feature_rgblight.md47
1 files changed, 24 insertions, 23 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 994a014a2..d323dee4f 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -119,7 +119,7 @@ if `RGBLIGHT_EFFECT_xxxx` or `RGBLIGHT_ANIMATIONS` is defined, you also have a n
119 119
120Check out [this video](https://youtube.com/watch?v=VKrpPAHlisY) for a demonstration. 120Check out [this video](https://youtube.com/watch?v=VKrpPAHlisY) for a demonstration.
121 121
122Note: For versions older than 0.6.117, The mode numbers were written directly. In `quantum/rgblight.h` there is a contrast table between the old mode number and the current symbol. 122Note: For versions older than 0.6.117, The mode numbers were written directly. In `quantum/rgblight/rgblight.h` there is a contrast table between the old mode number and the current symbol.
123 123
124### Effect and Animation Toggles 124### Effect and Animation Toggles
125 125
@@ -328,7 +328,7 @@ Normally lighting layers are not shown when RGB Lighting is disabled (e.g. with
328 328
329## Functions 329## Functions
330 330
331If you need to change your RGB lighting in code, for example in a macro to change the color whenever you switch layers, QMK provides a set of functions to assist you. See [`rgblight.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight.h) for the full list, but the most commonly used functions include: 331If you need to change your RGB lighting in code, for example in a macro to change the color whenever you switch layers, QMK provides a set of functions to assist you. See [`rgblight.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/rgblight/rgblight.h) for the full list, but the most commonly used functions include:
332 332
333### Utility Functions 333### Utility Functions
334|Function |Description | 334|Function |Description |
@@ -449,26 +449,27 @@ rgblight_sethsv_at(HSV_GREEN, 2); // led 2
449 449
450These are shorthands to popular colors. The `RGB` ones can be passed to the `setrgb` functions, while the `HSV` ones to the `sethsv` functions. 450These are shorthands to popular colors. The `RGB` ones can be passed to the `setrgb` functions, while the `HSV` ones to the `sethsv` functions.
451 451
452|RGB |HSV | 452|RGB |HSV |
453|-------------------|-------------------| 453|---------------------|---------------------|
454|`RGB_WHITE` |`HSV_WHITE` | 454|`RGB_AZURE` |`HSV_AZURE` |
455|`RGB_RED` |`HSV_RED` | 455|`RGB_BLACK`/`RGB_OFF`|`HSV_BLACK`/`HSV_OFF`|
456|`RGB_CORAL` |`HSV_CORAL` | 456|`RGB_BLUE` |`HSV_BLUE` |
457|`RGB_ORANGE` |`HSV_ORANGE` | 457|`RGB_CHARTREUSE` |`HSV_CHARTREUSE` |
458|`RGB_GOLDENROD` |`HSV_GOLDENROD` | 458|`RGB_CORAL` |`HSV_CORAL` |
459|`RGB_GOLD` |`HSV_GOLD` | 459|`RGB_CYAN` |`HSV_CYAN` |
460|`RGB_YELLOW` |`HSV_YELLOW` | 460|`RGB_GOLD` |`HSV_GOLD` |
461|`RGB_CHARTREUSE` |`HSV_CHARTREUSE` | 461|`RGB_GOLDENROD` |`HSV_GOLDENROD` |
462|`RGB_GREEN` |`HSV_GREEN` | 462|`RGB_GREEN` |`HSV_GREEN` |
463|`RGB_SPRINGGREEN` |`HSV_SPRINGGREEN` | 463|`RGB_MAGENTA` |`HSV_MAGENTA` |
464|`RGB_TURQUOISE` |`HSV_TURQUOISE` | 464|`RGB_ORANGE` |`HSV_ORANGE` |
465|`RGB_TEAL` |`HSV_TEAL` | 465|`RGB_PINK` |`HSV_PINK` |
466|`RGB_CYAN` |`HSV_CYAN` | 466|`RGB_PURPLE` |`HSV_PURPLE` |
467|`RGB_AZURE` |`HSV_AZURE` | 467|`RGB_RED` |`HSV_RED` |
468|`RGB_BLUE` |`HSV_BLUE` | 468|`RGB_SPRINGGREEN` |`HSV_SPRINGGREEN` |
469|`RGB_PURPLE` |`HSV_PURPLE` | 469|`RGB_TEAL` |`HSV_TEAL` |
470|`RGB_MAGENTA` |`HSV_MAGENTA` | 470|`RGB_TURQUOISE` |`HSV_TURQUOISE` |
471|`RGB_PINK` |`HSV_PINK` | 471|`RGB_WHITE` |`HSV_WHITE` |
472|`RGB_YELLOW` |`HSV_YELLOW` |
472 473
473```c 474```c
474rgblight_setrgb(RGB_ORANGE); 475rgblight_setrgb(RGB_ORANGE);
@@ -477,7 +478,7 @@ rgblight_setrgb_at(RGB_GOLD, 3);
477rgblight_sethsv_range(HSV_WHITE, 0, 6); 478rgblight_sethsv_range(HSV_WHITE, 0, 6);
478``` 479```
479 480
480These 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! 481These are defined in [`color.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/color.h). Feel free to add to this list!
481 482
482 483
483## Changing the order of the LEDs 484## Changing the order of the LEDs