Get the two remaining files out of the plugins directory in docs to make it easier to ignore this dir
parent
4f9afcfdb9
commit
589c2dd799
@ -1,35 +0,0 @@
|
||||
# TriColor
|
||||
|
||||
The `TriColor` effect extension is a part of
|
||||
the [`LEDEffects`][plugin:ledeffects] library, not a stand-alone base library of
|
||||
its own. It is used to implement the effects in that library.
|
||||
|
||||
[plugin:ledeffects]: Kaleidoscope-LEDEffects.md
|
||||
|
||||
It is a class that can be used to create LED effects that all follow a similar
|
||||
pattern: alphas and similar in one color; modifiers, special keys, and half the
|
||||
function keys in another, and `Esc` in a third (this latter being optional). If
|
||||
we have a color scheme that follows this pattern, the `TriColor` extension can
|
||||
make it a lot easier to implement it.
|
||||
|
||||
## Using the extension
|
||||
|
||||
Because the extension is part of the [`LEDEffects`][plugin:ledeffects] library,
|
||||
we need to include that header:
|
||||
|
||||
```c++
|
||||
#include <Kaleidoscope-LEDEffects.h>
|
||||
```
|
||||
|
||||
Then, we simply create a new instance of the `TriColor` class, with appropriate
|
||||
colors set for the constructor:
|
||||
|
||||
```c++
|
||||
kaleidoscope::plugin::TriColor BlackAndWhiteEffect (CRGB(0x00, 0x00, 0x00),
|
||||
CRGB(0xff, 0xff, 0xff),
|
||||
CRGB(0x80, 0x80, 0x80));
|
||||
```
|
||||
|
||||
The first argument is the base color, the second is for modifiers and special
|
||||
keys, the last one is for the `Esc` key. If the last one is omitted, the
|
||||
extension will use the modifier color for it.
|
@ -1,4 +1,4 @@
|
||||
# LEDControl
|
||||
# Kaleidoscope-LEDControl
|
||||
|
||||
This is a plugin for [Kaleidoscope][fw], for controlling the LEDs, and LED
|
||||
effects.
|
Loading…
Reference in new issue