From 498d89f4b345e3f5bccbbb8ac82df4eb7c582b1b Mon Sep 17 00:00:00 2001 From: Daniele De Vincenti <34176349+Napan0s@users.noreply.github.com> Date: Wed, 23 Dec 2020 06:59:26 +0100 Subject: [Docs] Add clarification on use of custom RGB Matrix effect (#11176) * Update feature_rgb_matrix.md Added more clarification on how to use a newly created rgb effect as it was unclear that the prefix 'RGB_MATRIX_CUSTOM_' had to be added. Also included an example consistent with the documentation example. * Update docs/feature_rgb_matrix.md Co-authored-by: Ryan * Update docs/feature_rgb_matrix.md Co-authored-by: Joel Challis Co-authored-by: Ryan Co-authored-by: Joel Challis --- docs/feature_rgb_matrix.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs') diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md index f8b0653551..a9e711c9f2 100644 --- a/docs/feature_rgb_matrix.md +++ b/docs/feature_rgb_matrix.md @@ -306,6 +306,12 @@ To declare new effects, create a new `rgb_matrix_user/kb.inc` that looks somethi `rgb_matrix_user.inc` should go in the root of the keymap directory. `rgb_matrix_kb.inc` should go in the root of the keyboard directory. +To use custom effects in your code, simply prepend `RGB_MATRIX_CUSTOM_` to the effect name specified in `RGB_MATRIX_EFFECT()`. For example, an effect declared as `RGB_MATRIX_EFFECT(my_cool_effect)` would be referenced with: + +```c +rgb_matrix_mode(RGB_MATRIX_CUSTOM_my_cool_effect); +``` + ```c // !!! DO NOT ADD #pragma once !!! // -- cgit v1.2.3