This is a library to integrate RGB-devices into your own application. It does not contain any executables!
If you're looking for a full blown software solution to manage your RGB-devices, take a look at Artemis.
- Add the RGB.NET.Core and Devices-Nugets for all devices you want to use.
- For some of the vendors SDK-libraries are needed. Check the contained Readmes for more information in that case.
- Create a new
RGBSurface surface = new RGBSurface();
- Initialize the providers for all devices you want to use and add the devices to the surface. For example:
CorsairDeviceProvider.Instance.Initialize(throwExceptions: true); surface.Attach(CorsairDeviceProvider.Instance.Devices);
Initialize-method allows to load only devices of specific types by setting a filter and for debugging purposes allows to enable exception throwing. (By default they are catched and provided through the
You can also use the
Load-Extension on the surface.
While most device-providers are implemented in a way that supports fast loading like this some may have a different loading procedures. (For example the
WS281XDeviceProviderrequires device-definitions before loading.)
- Add an update-trigger. In most cases the TimerUpdateTrigger is preferable, but you can also implement your own to fit your needs.
If you want to trigger updates manually the
ManualUpdateTriggershould be used.
- This step is optional but recommended. For rendering the location of each LED on the surface can be important. Since not all SDKs provide useful layout-information you might want to add Layouts to your devices. (TODO: add wiki article for this) Same goes for the location of the device on the surface. If you don't care about the exact location of the devices you can use:
The basic setup is now complete and you can start setting up your rendering.
As an example we'll add a moving rainbow over all devices on the surface.
- Create a led-group containing all leds on the surface (all devices)
ILedGroup allLeds = new ListLedGroup(surface, surface.Leds);
- Create a rainbow-gradient.
RainbowGradient rainbow = new RainbowGradient();
- Add a decorator to the gradient to make it move. (Decorators are
- Create a texture (the size - in this example 10, 10 - is not important here since the gradient shoukd be stretched anyway)
ITexture texture = new ConicalGradientTexture(new Size(10, 10), rainbow);
- Add a brush rendering the texture to the led-group
allLeds.Brush = new TextureBrush(texture);
RGBSurface surface = new RGBSurface(); surface.Load(CorsairDeviceProvider.Instance); surface.AlignDevices(); surface.RegisterUpdateTrigger(new TimerUpdateTrigger()); ILedGroup allLeds = new ListLedGroup(surface, surface.Leds); RainbowGradient rainbow = new RainbowGradient(); rainbow.AddDecorator(new MoveGradientDecorator(surface)); ITexture texture = new ConicalGradientTexture(new Size(10, 10), rainbow); allLeds.Brush = new TextureBrush(texture);