qmk-keychron-q3-colemak-dh/users/vitoni
2022-09-26 14:40:15 +10:00
..
readme.adoc [Keymap] Add vitoni keymap for GMMK Pro (ISO) (#15006) 2021-12-27 21:13:12 +11:00
rgb_matrix_effects.c [Keymap] Add vitoni keymap for GMMK Pro (ISO) (#15006) 2021-12-27 21:13:12 +11:00
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 [Keymap] Add vitoni keymap for GMMK Pro (ISO) (#15006) 2021-12-27 21:13:12 +11:00
utils.c [Keymap] Add vitoni keymap for GMMK Pro (ISO) (#15006) 2021-12-27 21:13:12 +11:00
utils.h [Keymap] Add vitoni keymap for GMMK Pro (ISO) (#15006) 2021-12-27 21:13:12 +11:00
vitoni.c Change {LED,RGB}_DISABLE_TIMEOUT to {LED,RGB}_MATRIX_TIMEOUT (#18415) 2022-09-26 14:40:15 +10:00
vitoni.h [Keymap] Add vitoni keymap for GMMK Pro (ISO) (#15006) 2021-12-27 21:13:12 +11:00

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