readme.adoc 686 B

12345678910111213141516
  1. = User functions
  2. Functions are mostly related to changing the RGB lights depending on user interaction and when idling.
  3. == utils.h
  4. Common functions are declared in link:utils.h[]. These function are not directly RGB related but used to modify state and calculate values.
  5. == rgb_matrix_effects.h
  6. 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.
  7. == vitoni.h
  8. The functions declared in link:vitoni.h[] are used as entry points for usage of RGB effects.
  9. One entry point is `matrix_scan` based for regular task while the other is `process_record` based for user activity tasks.