<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">} };</span></span></code></pre></div><p>The first part, <code>// Key Matrix to LED Index</code>, tells the system what key this LED represents by using the key's electrical matrix row & col. The second part, <code>// LED Index to Physical Position</code> represents the LED's physical <code>{ x, y }</code> position on the keyboard. The default expected range of values for <code>{ x, y }</code> is the inclusive range <code>{ 0..224, 0..64 }</code>. This default expected range is due to effects that calculate the center of the keyboard for their animations. The easiest way to calculate these positions is imagine your keyboard is a grid, and the top left of the keyboard represents <code>{ x, y }</code> coordinate <code>{ 0, 0 }</code> and the bottom right of your keyboard represents <code>{ 224, 64 }</code>. Using this as a basis, you can use the following formula to calculate the physical position:</p><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">x </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 224</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"> /</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (NUMBER_OF_COLS </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">-</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 1</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">*</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> COL_POSITION</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">y </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 64</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"> /</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (NUMBER_OF_ROWS </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">-</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 1</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">*</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ROW_POSITION</span></span></code></pre></div><p>Where NUMBER_OF_COLS, NUMBER_OF_ROWS, COL_POSITION, & ROW_POSITION are all based on the physical layout of your keyboard, not the electrical layout.</p><p>As mentioned earlier, the center of the keyboard by default is expected to be <code>{ 112, 32 }</code>, but this can be changed if you want to more accurately calculate the LED's physical <code>{ x, y }</code> positions. Keyboard designers can implement <code>#define RGB_MATRIX_CENTER { 112, 32 }</code> in their config.h file with the new center point of the keyboard, or where they want it to be allowing more possibilities for the <code>{ x, y }</code> values. Do note that the maximum value for x or y is 255, and the recommended maximum is 224 as this gives animations runoff room before they reset.</p><p><code>// LED Index to Flag</code> is a bitmask, whether or not a certain LEDs is of a certain type. It is recommended that LEDs are set to only 1 type.</p><h2id="flags"tabindex="-1">Flags <aclass="header-anchor"href="#flags"aria-label="Permalink to "Flags {#flags}""></a></h2><table><thead><tr><th>Define</th><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>HAS_FLAGS(bits, flags)</code></td><td><em>n/a</em></td><td>Evaluates to <code>true</code> if <code>bits</code> has all <code>flags</code> set</td></tr><tr><td><code>HAS_ANY_FLAGS(bits, flags)</code></td><td><em>n/a</em></td><td>Evaluates to <code>true</code> if <code>bits</code> has any <code>flags</code> set</td></tr><tr><td><code>LED_FLAG_NONE</code></td><td><code>0x00</code></td><td>If this LED has no flags</td></tr><tr><td><code>LED_FLAG_ALL</code></td><td><code>0xFF</code></td><td>If this LED has all flags</td></tr><tr><td><code>LED_FLAG_MODIFIER</code></td><td><code>0x01</code></td><td>If the LED is on a modifier key</td></tr><tr><td><code>LED_FLAG_UNDERGLOW</code></td><td><code>0x02</code></td><td>If the LED is for underglow</td></tr><tr><td><code>LED_FLAG_KEYLIGHT</code></td><td><code>0x04</code></td><td>If the LED is for key backlight</td></tr><tr><td><code>LED_FLAG_INDICATOR</code></td><td><code>0x08</code></td><td>If the LED is for keyboard state indication</td></tr></tbody></table><h2id="keycodes"tabindex="-1">Keycodes <aclass="header-anchor"href="#keycodes"aria-label="Permalink to "Keycodes {#keycodes}""></a></h2><p>All RGB keycodes are currently shared with the RGBLIGHT system:</p><table><thead><tr><th>Key</th><th>Aliases</th><th>Description</th></tr></thead><tbody><tr><td><code>RGB_TOG</code></td><td></td><td>Toggle RGB lighting on or off</td></tr><tr><td><code>RGB_MODE_FORWARD</code></td><td><code>RGB_MOD</code></td><td>Cycle through modes, reverse direction when Shift is held</td></tr><tr><td><code>RGB_MODE_REVERSE</code></td><td><code>RGB_RMOD</code></td><td>Cycle through modes in reverse, forward direction when Shift is held</td></tr><tr><td><code>RGB_HUI</code></td><td></td><td>Increase hue, decrease hue when Shift is held</td></tr><tr><td><code>RGB_HUD</code></td><td></td><td>Decrease hue, increase hue when Shift is held</td></tr><tr><td><code>RGB_SAI</code></td><td></td><td>Increase saturation, decrease saturation when Shift is held</td></tr><tr><td><code>RGB_SAD</code></td><td></td><td>Decrease saturation, increase saturation when Shift is held</td></tr><tr><td><code>RGB_VAI</code></td><td></td><td>Incre
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_COLOR </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 1</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Static single hue, no speed support</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_ALPHAS_MODS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Static dual hue, speed is hue for secondary hue</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_GRADIENT_UP_DOWN,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Static gradient top to bottom, speed controls how much gradient changes</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_GRADIENT_LEFT_RIGHT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Static gradient left to right, speed controls how much gradient changes</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_BREATHING,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Single hue brightness cycling animation</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_BAND_SAT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Single hue band fading saturation scrolling left to right</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_BAND_VAL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Single hue band fading brightness scrolling left to right</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_BAND_SPIRAL_SAT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Single hue spinning spiral fades saturation</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_BAND_SPIRAL_VAL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Single hue spinning spiral fades brightness</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_ALL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full keyboard solid hue cycling through full gradient</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_LEFT_RIGHT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient scrolling left to right</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_UP_DOWN,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient scrolling top to bottom</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_OUT_IN,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient scrolling out to in</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_OUT_IN_DUAL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full dual gradients scrolling out to in</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_RAINBOW_MOVING_CHEVRON,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient Chevron shapped scrolling left to right</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_PINWHEEL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient spinning pinwheel around center of keyboard</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_SPIRAL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient spinning spiral around center of keyboard</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_DUAL_BEACON,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient spinning around center of keyboard</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_RAINBOW_BEACON,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full tighter gradient spinning around center of keyboard</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_RAINBOW_PINWHEELS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full dual gradients spinning two halfs of keyboard</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_FLOWER_BLOOMING,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full tighter gradient of first half scrolling left to right and second half scrolling right to left</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_RAINDROPS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Randomly changes a single key's hue</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_JELLYBEAN_RAINDROPS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Randomly changes a single key's hue and saturation</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_HUE_BREATHING,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue shifts up a slight ammount at the same time, then shifts back</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_HUE_PENDULUM,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue shifts up a slight ammount in a wave to the right, then back to the left</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_HUE_WAVE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue shifts up a slight ammount and then back down in a wave to the right</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_PIXEL_FRACTAL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Single hue fractal filled keys pulsing horizontally out to edges</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_PIXEL_FLOW,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Pulsing RGB flow along LED wiring with random hues</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_PIXEL_RAIN,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Randomly light keys with random hues</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_TYPING_HEATMAP,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // How hot is your WPM!</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_DIGITAL_RAIN,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // That famous computer simulation</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_SIMPLE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Pulses keys hit to hue & value then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Static single hue, pulses keys hit to shifted hue then fades to current hue</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_WIDE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse near a single key hit then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse near multiple key hits then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_CROSS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse the same column and row of a single key hit then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_MULTICROSS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse the same column and row of multiple key hits then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_NEXUS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse away on the same column and row of a single key hit then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse away on the same column and row of multiple key hits then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SPLASH,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient & value pulse away from a single key hit then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_MULTISPLASH,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient & value pulse away from multiple key hits then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_SPLASH,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse away from a single key hit then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_MULTISPLASH,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse away from multiple key hits then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_STARLIGHT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // LEDs turn on and off at random at varying brightness, maintaining user set color</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_STARLIGHT_DUAL_HUE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // LEDs turn on and off at random at varying brightness, modifies user set hue by +- 30</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_STARLIGHT_DUAL_SAT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // LEDs turn on and off at random at varying brightness, modifies user set saturation by +- 30</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_RIVERFLOW,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Modification to breathing animation, offset's animation depending on key location to simulate a river flowing</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// e.g: A simple effect, self-contained within a single method</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// e.g: A more complex effect, relying on external methods and state, with</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// dedicated init and run methods</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#endif</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // RGB_MATRIX_CUSTOM_EFFECT_IMPLS</span></span></code></pre></div><p>To switch to your custom effect programmatically, simply call <code>rgb_matrix_mode()</code> and prepend <code>RGB_MATRIX_CUSTOM_</code> to the effect name you specified in <code>RGB_MATRIX_EFFECT()</code>. For example, an effect declared as <code>RGB_MATRIX_EFFECT(my_cool_effect)</code> would be referenced with:</p><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">rgb_matrix_mode</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(RGB_MATRIX_CUSTOM_my_cool_effect);</span></span></code></pre></div><p>For inspiration and examples, check out the built-in effects under <code>quantum/rgb_matrix/animations/</code>.</p><h2id="colors"tabindex="-1">Colors <aclass="header-anchor"href="#colors"aria-label="Permalink to "Colors {#colors}""></a></h2><p>These are shorthands to popular colors. The <code>RGB</code> ones can be passed to the <code>setrgb</code> functions, while the <code>HSV</code> ones to the <code>sethsv</code> functions.</p><table><thead><tr><th>RGB</th><th>HSV</th></tr></thead><tbody><tr><td><code>RGB_AZURE</code></td><td><code>HSV_AZURE</code></td></tr><tr><td><code>RGB_BLACK</code>/<code>RGB_OFF</code></td><td><code>HSV_BLACK</code>/<code>HSV_OFF</code></td></tr><tr><td><code>RGB_BLUE</code></td><td><code>HSV_BLUE</code></td></tr><tr><td><code>RGB_CHARTREUSE</code></td><td><code>HSV_CHARTREUSE</code></td></tr><tr><td><code>RGB_CORAL</code></td><td><code>HSV_CORAL</code></td></tr><tr><td><code>RGB_CYAN</code></td><td><code>HSV_CYAN</code></td></tr><tr><td><code>RGB_GOLD</code></td><td><code>HSV_GOLD</code></td></tr><tr><td><code>RGB_GOLDENROD</code></td><td><code>HSV_GOLDENROD</code></td></tr><tr><td><code>RGB_GREEN</code></td><td><code>HSV_GREEN</code></td></tr><tr><td><code>RGB_MAGENTA</code></td><td><code>HSV_MAGENTA</code></td></tr><tr><td><code>RGB_ORANGE</code></td><td><code>HSV_ORANGE</code></td></tr><tr><td><code>RGB_PINK</code></td><td><code>HSV_PINK</code></td></tr><tr><td><code>RGB_PURPLE</code></td><td><code>HSV_PURPLE</code></td></tr><tr><td><code>RGB_RED</code></td><td><code>HSV_RED</code></td></tr><tr><td><code>RGB_SPRINGGREEN</code></td><td><code>HSV_SPRINGGREEN</code></td></tr><tr><td><code>RGB_TEAL</code></td><td><code>HSV_TEAL</code></td></tr><tr><td><code>RGB_TURQUOISE</code></td><td><code>HSV_TURQUOISE</code></td></tr><tr><td><code>RGB_WHITE</code></td><td><code>HSV_WHITE</code></td></tr><tr><td><code>RGB_YELLOW</code></td><td><code>HSV_YELLOW</code></td></tr></tbody></table><p>These are defined in <ahref="https://github.com/qmk/qmk_firmware/blob/master/quantum/color.h"target="_blank"rel="noreferrer"><code>color.h</code></a>. Feel free to add to this list!</p><h2id="additional-configh-options"tabindex="-1">Additional <code>config.h</code> Options <aclass="header-anchor"href="#additional-configh-options"aria-label="Permalink to "Additional `config.h` Options {#additional-configh-options}""></a></h2><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_KEYRELEASES</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // reactive effects respond to keyreleases (instead of keypresses)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_TIMEOUT</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 0</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // number of milliseconds to wait until rgb automatically turns off</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_SLEEP</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // turn off effects when suspended</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_LED_PROCESS_LIMIT</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (RGB_MATRIX_LED_COUNT </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">+</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 4</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">/</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 5</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_LED_FLUSH_LIMIT</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 16</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_MAXIMUM_BRIGHTNESS</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 200</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // limits maximum brightness of LEDs to 200 out of 255. If not defined maximum brightness is set to 255</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_ON</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> true</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default enabled state, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_MODE</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_LEFT_RIGHT</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default mode, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_HUE</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 0</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default hue value, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_SAT</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 255</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default saturation value, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_VAL</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_MAXIMUM_BRIGHTNESS</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default brightness value, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_SPD</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 127</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default animation speed, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_FLAGS</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_FLAG_ALL</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default LED flags, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DISABLE_KEYCODES</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // disables control of rgb matrix by keycodes (must use code functions to control the feature)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_SPLIT</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { X, Y }</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_TRIGGER_ON_KEYDOWN</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Triggers RGB keypress events on key down. This makes RGB control feel more responsive. This may cause RGB to not function properly on some boards</span></span></code></pre></div><h2id="eeprom-storage"tabindex="-1">EEPROM storage <aclass="header-anchor"href="#eeprom-storage"aria-label="Permalink to "EEPROM storage {#eeprom-storage}""></a></h2><p>The EEPROM for it is currently shared with the LED Matrix system (it's generally assumed only one feature would be used at a time).</p><h2id="callbacks"tabindex="-1">Callbacks <aclass="header-anchor"href="#callbacks"aria-label="Permalink to "Callbacks {#callbacks}""></a></h2><h3id="indicators"tabindex="-1">Indicators <aclass="header-anchor"href="#indicators"aria-label="Permalink to "Indicators {#indicators}""></a></h3><p>If you want to set custom indicators, such as an LED for Caps Lock, or layer indication, then you can use the <code>rgb_matrix_indicators_kb</code> function on the keyboard level source file, or <code>rgb_matrix_indicators_user</code> function in the user <code>keymap.c</code>.</p><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">bool</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> rgb_matrix_indicators_kb</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">void</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>In addition, there are the advanced indicator functions. These are aimed at those with heavily customized displays, where rendering every LED per cycle is expensive. Such as some of the "drashna" layouts. This includes a special macro to help make this easier to use: <code>RGB_MATRIX_INDICATOR_SET_COLOR(i, r, g, b)</code>.</p><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">bool</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> rgb_matrix_indicators_advanced_user</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_min</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_max</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"> for</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> col </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 0</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">; col </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"><</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> MATRIX_COLS; </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">++</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">col) {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint8_t</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> index </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> g_led_config.matrix_co[row][col];</span></span>
<spanclass="line"></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"> if</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (index </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">>=</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> led_min </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">&&</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> index </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"><</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> led_max </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">&&</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> index </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">!=</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> NO_LED </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">&&</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><divclass="tip custom-block"><pclass="custom-block-title">TIP</p><p>Split keyboards will require layer state data syncing with <code>#define SPLIT_LAYER_STATE_ENABLE</code>. See <ahref="./split_keyboard#data-sync-options">Data Sync Options</a> for more details.</p></div><h4id="indicator-examples-2"tabindex="-1">Examples <aclass="header-anchor"href="#indicator-examples-2"aria-label="Permalink to "Examples {#indicator-examples-2}""></a></h4><p>This example sets the modifiers to be a specific color based on the layer state. You can use a switch case here, instead, if you would like. This uses HSV and then converts to RGB, because this allows the brightness to be limited (important when using the WS2812 driver).</p><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">bool</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> rgb_matrix_indicators_advanced_user</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_min</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_max</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>If you want to indicate a Host LED status (caps lock, num lock, etc), you can use something like this to light up the caps lock key:</p><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">bool</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> rgb_matrix_indicators_advanced_user</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_min</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_max</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_INDICATOR_SET_COLOR</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">5</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">255</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">255</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">255</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // assuming caps lock is at led #5</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><divclass="tip custom-block"><pclass="custom-block-title">TIP</p><p>RGB indicators on split keyboards will require state information synced to the slave half (e.g. <code>#define SPLIT_LAYER_STATE_ENABLE</code>). See <ahref="./split_keyboard#data-sync-options">data sync options</a> for more details.</p></div><h4id="indicators-without-rgb-matrix-effect"tabindex="-1">Indicators without RGB Matrix Effect <aclass="header-anchor"href="#indicators-without-rgb-matrix-effect"aria-label="Permalink to "Indicators without RGB Matrix Effect""></a></h4><p>If you want to just use RGB indicators without RGB matrix effect, it is not possible to disable the latter because toggling RGB off will disable everything. You can workaround it with solid effect and colors off using this init function:</p><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">void</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> keyboard_post_init_user</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">void</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h2id="api"tabindex="-1">API <aclass="header-anchor"href="#api"aria-label="Permalink to "API {#api}""></a></h2><h3id="api-rgb-matrix-toggle"tabindex="-1"><code>void rgb_matrix_toggle(void)</code><aclass="header-anchor"href="#api-rgb-matrix-toggle"aria-label="Permalink to "`void rgb_matrix_toggle(void)` {#api-rgb-matrix-toggle}""></a></h3><p>Toggle RGB Matrix on or off.</p><hr><h3id="api-rgb-matrix-toggle-noeeprom"tabindex="-1"><code>void rgb_matrix_toggle_noeeprom(void)</code><aclass="header-anchor"href="#api-rgb-matrix-toggle-noeeprom"aria-label="Permalink to "`void rgb_matrix_toggle_noeeprom(void)` {#api-rgb-matrix-toggle-noeeprom}""></a></h3><p>Toggle RGB Matrix on or off. New state is not written to EEPROM.</p><hr><h3id="api-rgb-matrix-enable"tabindex="-1"><code>void rgb_matrix_enable(void)</code><aclass="header-anchor"href="#api-rgb-matrix-enable"aria-label="Permalink to "`void rgb_matrix_enable(void)` {#api-rgb-matrix-enable}""></a></h3><p>Turn RGB Matrix on.</p><hr><h3id="api-rgb-matrix-enable-noeeprom"tabindex="-1"><code>void rgb_matrix_enable_noeeprom(void)</code><aclass="header-anchor"href="#api-rgb-matrix-enable-noeeprom"aria-label="Permalink to "`void rgb_matrix_enable_noeeprom(void)` {#api-rgb-matrix-enable-noeeprom}""></a></h3><p>Turn RGB Matrix on. New state is not written to EEPROM.</p><hr><h3id="api-rgb-matrix-disable"tabindex="-1"><code>void rgb_matrix_disable(void)</code><aclass="header-anchor"href="#api-rgb-matrix-disable"aria-label="Permalink to "`void rgb_matrix_disable(void)` {#api-rgb-matrix-disable}""></a></h3><p>Turn RGB Matrix off.</p><hr><h3id="api-rgb-matrix-disable-noeeprom"tabindex="-1"><code>void rgb_matrix_disable_noeeprom(void)</code><aclass="header-anchor"href="#api-rgb-matrix-disable-noeeprom"aria-label="Permalink to "`void rgb_matrix_disable_noeeprom(void)` {#api-rgb-matrix-disable-noeeprom}""></a></h3><p>Turn RGB Matrix off. New state is not written to EEPROM.</p><hr><h3id="api-rgb-matrix-is-enabled"tabindex="-1"><code>bool rgb_matrix_is_enabled(void)</code><aclass="header-anchor"href="#api-rgb-matrix-is-enabled"aria-label="Permalink to "`bool rgb_matrix_is_enabled(void)` {#api-rgb-matrix-is-enabled}""></a></h3><p>Get the current enabled state of RGB Matrix.</p><h4id="api-rgb-matrix-is-enabled-return"tabindex="-1">Return Value <aclass="header-anchor"href="#api-rgb-matrix-is-enabled-return"aria-label="Permalink to "Return Value {#api-rgb-matrix-is-enabled-return}""></a></h4><p><code>true</code> if RGB Matrix is enabled.</p><hr><h3id="api-rgb-matrix-set-color"tabindex="-1"><code>void rgb_matrix_set_color(uint8_t index, uint8_t r, uint8_t g, uint8_t b)</code><aclass="header-anchor"href="#api-rgb-matrix-set-color"aria-label="Permalink to "`void rgb_matrix_set_color(uint8_t index, uint8_t r, uint8_t g, uint8_t b)` {#api-rgb-matrix-set-color}""></a></h3><p>Set the color of a single LED.</p><p>This function can only be run from within an effect or indicator callback, otherwise the currently running animation will simply overwrite it on the next frame.</p><h4id="api-rgb-matrix-set-color-arguments"tabindex="-1">Arguments <aclass="header-anchor"href="#api-rgb-matrix-set-color-arguments"aria-label="Permalink to "Arguments {#api-rgb-matrix-set-color-arguments}""></a></h4><ul><li><code>uint8_t index</code><br> The LED index, from 0 to <code>RGB_MATRIX_LED_COUNT - 1</code>.</li><li><code>uint8_t r</code><br> The red value to set.</li><li><code>uint8_t g</code><br> The green value to set.</li><li><code>uint8_t b</code><br> The blue value to set.</li></ul><hr><h3id="api-rgb-matrix-set-color-all"tabindex="-1"><code>void rgb_matrix_set_color_all(uint8_t r, uint8_t g, uint8_t b)</code><aclass="header-anchor"href="#api-rgb-matrix-set-color-all"aria-label="Permalinkto"`voidrgb_m
