diff options
| author | zvecr <git@zvecr.com> | 2022-02-25 23:45:40 +0000 |
|---|---|---|
| committer | zvecr <git@zvecr.com> | 2022-02-25 23:45:40 +0000 |
| commit | e7931289918221081cbe2a7ea5df27a5d86324db (patch) | |
| tree | 0b06145520f8aaf5ff5cb928aa5176fc2dd23619 /users/vitoni/readme.adoc | |
| parent | c0ee3d2c79388187883b1b1b1d1a0b6842acf741 (diff) | |
| parent | cf31355f08dca311a013168eb3eb995e2fc6a3d1 (diff) | |
| download | qmk_firmware-e7931289918221081cbe2a7ea5df27a5d86324db.tar.gz qmk_firmware-e7931289918221081cbe2a7ea5df27a5d86324db.zip | |
Merge remote-tracking branch 'origin/develop'
Diffstat (limited to 'users/vitoni/readme.adoc')
| -rw-r--r-- | users/vitoni/readme.adoc | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/users/vitoni/readme.adoc b/users/vitoni/readme.adoc new file mode 100644 index 0000000000..acf65793d2 --- /dev/null +++ b/users/vitoni/readme.adoc @@ -0,0 +1,16 @@ += User functions + +Functions are mostly related to changing the RGB lights depending on user interaction and when idling. + +== utils.h + +Common functions are declared in link:utils.h[]. These function are not directly RGB related but used to modify state and calculate values. + +== rgb_matrix_effects.h + +Functions in link:rgb_matrix_effects.h[] make use of common function in `utils.h` and are used to create to RGB matrix effects such as fading or breathing. + +== vitoni.h + +The functions declared in link:vitoni.h[] are used as entry points for usage of RGB effects. +One entry point is `matrix_scan` based for regular task while the other is `process_record` based for user activity tasks. |