diff options
| author | Albert Y <76888457+filterpaper@users.noreply.github.com> | 2022-02-06 13:16:36 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-05 21:16:36 -0800 |
| commit | 7a0b07f84b4afe95342aa1d311055961bd217b29 (patch) | |
| tree | e29bce15cbee0ad0122c8110dd62237bdb17e3b8 | |
| parent | 88a22268eb3f932b485f524dadc52c93163ae839 (diff) | |
| download | qmk_firmware-7a0b07f84b4afe95342aa1d311055961bd217b29.tar.gz qmk_firmware-7a0b07f84b4afe95342aa1d311055961bd217b29.zip | |
[Docs] RGB documentation formatting corrections (#15826)
| -rw-r--r-- | docs/feature_rgb_matrix.md | 8 | ||||
| -rw-r--r-- | docs/feature_rgblight.md | 7 |
2 files changed, 9 insertions, 6 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md index 3384aa718..536609b39 100644 --- a/docs/feature_rgb_matrix.md +++ b/docs/feature_rgb_matrix.md | |||
| @@ -418,6 +418,8 @@ All RGB keycodes are currently shared with the RGBLIGHT system: | |||
| 418 | `RGB_MODE_PLAIN`, `RGB_MODE_BREATHE`, `RGB_MODE_RAINBOW`, and `RGB_MODE_SWIRL` are the only ones that are mapped properly. The rest don't have a direct equivalent, and are not mapped. | 418 | `RGB_MODE_PLAIN`, `RGB_MODE_BREATHE`, `RGB_MODE_RAINBOW`, and `RGB_MODE_SWIRL` are the only ones that are mapped properly. The rest don't have a direct equivalent, and are not mapped. |
| 419 | 419 | ||
| 420 | ?> `RGB_*` keycodes cannot be used with functions like `tap_code16(RGB_HUD)` as they're not USB HID keycodes. If you wish to replicate similar behaviour in custom code within your firmware (e.g. inside `encoder_update_user()` or `process_record_user()`), the equivalent [RGB functions](#functions-idfunctions) should be used instead. | 420 | ?> `RGB_*` keycodes cannot be used with functions like `tap_code16(RGB_HUD)` as they're not USB HID keycodes. If you wish to replicate similar behaviour in custom code within your firmware (e.g. inside `encoder_update_user()` or `process_record_user()`), the equivalent [RGB functions](#functions-idfunctions) should be used instead. |
| 421 | |||
| 422 | |||
| 421 | !> By default, if you have both the [RGB Light](feature_rgblight.md) and the RGB Matrix feature enabled, these keycodes will work for both features, at the same time. You can disable the keycode functionality by defining the `*_DISABLE_KEYCODES` option for the specific feature. | 423 | !> By default, if you have both the [RGB Light](feature_rgblight.md) and the RGB Matrix feature enabled, these keycodes will work for both features, at the same time. You can disable the keycode functionality by defining the `*_DISABLE_KEYCODES` option for the specific feature. |
| 422 | 424 | ||
| 423 | ## RGB Matrix Effects :id=rgb-matrix-effects | 425 | ## RGB Matrix Effects :id=rgb-matrix-effects |
| @@ -555,9 +557,7 @@ In order to change the delay of temperature decrease define | |||
| 555 | 557 | ||
| 556 | ## Custom RGB Matrix Effects :id=custom-rgb-matrix-effects | 558 | ## Custom RGB Matrix Effects :id=custom-rgb-matrix-effects |
| 557 | 559 | ||
| 558 | By setting `RGB_MATRIX_CUSTOM_USER = yes` in `rules.mk`, new effects can be defined directly from your keymap or userspace, without having to edit any QMK core files. | 560 | By setting `RGB_MATRIX_CUSTOM_USER = yes` in `rules.mk`, new effects can be defined directly from your keymap or userspace, without having to edit any QMK core files. To declare new effects, create a `rgb_matrix_user.inc` file in the user keymap directory or userspace folder. |
| 559 | |||
| 560 | To declare new effects, create a `rgb_matrix_user.inc` file in the user keymap directory or userspace folder. | ||
| 561 | 561 | ||
| 562 | ?> Hardware maintainers who want to limit custom effects to a specific keyboard can create a `rgb_matrix_kb.inc` file in the root of the keyboard directory, and add `RGB_MATRIX_CUSTOM_KB = yes` to the keyboard level `rules.mk`. | 562 | ?> Hardware maintainers who want to limit custom effects to a specific keyboard can create a `rgb_matrix_kb.inc` file in the root of the keyboard directory, and add `RGB_MATRIX_CUSTOM_KB = yes` to the keyboard level `rules.mk`. |
| 563 | 563 | ||
| @@ -810,6 +810,8 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) { | |||
| 810 | } | 810 | } |
| 811 | ``` | 811 | ``` |
| 812 | 812 | ||
| 813 | ?> Split keyboards will require layer state data syncing with `#define SPLIT_LAYER_STATE_ENABLE`. See [Data Sync Options](feature_split_keyboard?id=data-sync-options) for more details. | ||
| 814 | |||
| 813 | #### Examples :id=indicator-examples | 815 | #### Examples :id=indicator-examples |
| 814 | 816 | ||
| 815 | This example sets the modifiers to be a specific color based on the layer state. You can use a switch case here, instead, if you would like. This uses HSV and then converts to RGB, because this allows the brightness to be limited (important when using the WS2812 driver). | 817 | This example sets the modifiers to be a specific color based on the layer state. You can use a switch case here, instead, if you would like. This uses HSV and then converts to RGB, because this allows the brightness to be limited (important when using the WS2812 driver). |
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md index 7fafaff47..194daee29 100644 --- a/docs/feature_rgblight.md +++ b/docs/feature_rgblight.md | |||
| @@ -76,9 +76,10 @@ Changing the **Value** sets the overall brightness.<br> | |||
| 76 | |`RGB_MODE_RGBTEST` |`RGB_M_T` |Red, Green, Blue test animation mode | | 76 | |`RGB_MODE_RGBTEST` |`RGB_M_T` |Red, Green, Blue test animation mode | |
| 77 | |`RGB_MODE_TWINKLE` |`RGB_M_TW`|Twinkle animation mode | | 77 | |`RGB_MODE_TWINKLE` |`RGB_M_TW`|Twinkle animation mode | |
| 78 | 78 | ||
| 79 | !> By default, if you have both the RGB Light and the [RGB Matrix](feature_rgb_matrix.md) feature enabled, these keycodes will work for both features, at the same time. You can disable the keycode functionality by defining the `*_DISABLE_KEYCODES` option for the specific feature. | 79 | ?> `RGB_*` keycodes cannot be used with functions like `tap_code16(RGB_HUI)` as they're not USB HID keycodes. If you wish to replicate similar behaviour in custom code within your firmware (e.g. inside `encoder_update_user()` or `process_record_user()`), the equivalent [RGB functions](#functions) should be used instead. |
| 80 | |||
| 80 | 81 | ||
| 81 | ?> `RGB_*` keycodes cannot be used with functions like `tap_code16(RGB_HUI)` as they're not USB HID keycodes. If you wish to replicate similar behaviour in custom code within your firmware (e.g. inside `encoder_update_user()` or `process_record_user()`), the equivalent [RGB functions](#functions-idfunctions) should be used instead. | 82 | !> By default, if you have both the RGB Light and the [RGB Matrix](feature_rgb_matrix.md) feature enabled, these keycodes will work for both features, at the same time. You can disable the keycode functionality by defining the `*_DISABLE_KEYCODES` option for the specific feature. |
| 82 | 83 | ||
| 83 | ## Configuration | 84 | ## Configuration |
| 84 | 85 | ||
| @@ -203,7 +204,7 @@ const uint8_t RGBLED_GRADIENT_RANGES[] PROGMEM = {255, 170, 127, 85, 64}; | |||
| 203 | 204 | ||
| 204 | ## Lighting Layers | 205 | ## Lighting Layers |
| 205 | 206 | ||
| 206 | ?> **Note:** Lighting Layers is an RGB Light feature, it will not work for RGB Matrix. See [RGB Matrix Indicators](feature_rgb_matrix.md?indicators) for details on how to do so. | 207 | ?> **Note:** Lighting Layers is an RGB Light feature, it will not work for RGB Matrix. See [RGB Matrix Indicators](feature_rgb_matrix.md#indicators) for details on how to do so. |
| 207 | 208 | ||
| 208 | By including `#define RGBLIGHT_LAYERS` in your `config.h` file you can enable lighting layers. These make | 209 | By including `#define RGBLIGHT_LAYERS` in your `config.h` file you can enable lighting layers. These make |
| 209 | it easy to use your underglow LEDs as status indicators to show which keyboard layer is currently active, or the state of caps lock, all without disrupting any animations. [Here's a video](https://youtu.be/uLGE1epbmdY) showing an example of what you can do. | 210 | it easy to use your underglow LEDs as status indicators to show which keyboard layer is currently active, or the state of caps lock, all without disrupting any animations. [Here's a video](https://youtu.be/uLGE1epbmdY) showing an example of what you can do. |
