keychron_qmk_firmware

mirror of https://github.com/Keychron/qmk_firmware.git synced 2024-11-25 18:06:34 +06:00

History

Ryan ea2819b2c2 Change `{LED,RGB}_DISABLE_TIMEOUT` to `{LED,RGB}_MATRIX_TIMEOUT` (#18415 )		2022-09-26 14:40:15 +10:00
..
readme.adoc
rgb_matrix_effects.c
rgb_matrix_effects.h	Change `{LED,RGB}_DISABLE_TIMEOUT` to `{LED,RGB}_MATRIX_TIMEOUT` (#18415 )	2022-09-26 14:40:15 +10:00
rules.mk
utils.c
utils.h
vitoni.c	Change `{LED,RGB}_DISABLE_TIMEOUT` to `{LED,RGB}_MATRIX_TIMEOUT` (#18415 )	2022-09-26 14:40:15 +10:00
vitoni.h

readme.adoc

= 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.