Class SteelSeriesDeviceProvider

Represents the abstract base implementation for a IRGBDeviceProvider.

Inheritance
object
AbstractRGBDeviceProvider
SteelSeriesDeviceProvider
Implements
Inherited Members
Namespace: RGB.NET.Devices.SteelSeries
Assembly: RGB.NET.Devices.SteelSeries.dll
Syntax
public sealed class SteelSeriesDeviceProvider : AbstractRGBDeviceProvider, IRGBDeviceProvider, IDisposable

Constructors

| Edit this page View Source

SteelSeriesDeviceProvider()

Initializes a new instance of the SteelSeriesDeviceProvider class.

Declaration
public SteelSeriesDeviceProvider()
Exceptions
Type Condition
InvalidOperationException

Thrown if this constructor is called even if there is already an instance of this class.

Properties

| Edit this page View Source

DeviceDefinitions

Gets the HID-definitions for SteelSeries-devices.

Declaration
public static HIDLoader<SteelSeriesLedId, SteelSeriesDeviceType> DeviceDefinitions { get; }
Property Value
Type Description
HIDLoader<SteelSeriesLedId, SteelSeriesDeviceType>
| Edit this page View Source

Instance

Gets the singleton SteelSeriesDeviceProvider instance.

Declaration
public static SteelSeriesDeviceProvider Instance { get; }
Property Value
Type Description
SteelSeriesDeviceProvider

Methods

| Edit this page View Source

CreateUpdateTrigger(int, double)

Creates a update trigger with the specified id and the specified update rate hard limit.

Declaration
protected override IDeviceUpdateTrigger CreateUpdateTrigger(int id, double updateRateHardLimit)
Parameters
Type Name Description
int id

The id of the update trigger.
double updateRateHardLimit

The update rate hard limit tobe set in the update trigger.
Returns
Type Description
IDeviceUpdateTrigger

The newly created update trigger.
Overrides
| Edit this page View Source

Dispose(bool)

Disposes the object and frees all resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

true if explicitely called through the Dispose-Method, false if called by the destructor.
Overrides
| Edit this page View Source

GetLoadedDevices(RGBDeviceType)

Loads devices and returns a filtered list of them.

Declaration
protected override IEnumerable<IRGBDevice> GetLoadedDevices(RGBDeviceType loadFilter)
Parameters
Type Name Description
RGBDeviceType loadFilter

RGBDeviceType-flags to filter the device with.
Returns
Type Description
IEnumerable<IRGBDevice>

The filtered collection of loaded devices.
Overrides
Remarks

The underlying loading of the devices happens in LoadDevices().

| Edit this page View Source

InitializeSDK()

Initializes the underlying SDK.

Declaration
protected override void InitializeSDK()
Overrides
| Edit this page View Source

LoadDevices()

Loads all devices this device provider is capable of loading.

Declaration
protected override IEnumerable<IRGBDevice> LoadDevices()
Returns
Type Description
IEnumerable<IRGBDevice>

A collection of loaded devices.
Overrides
Remarks

Filtering happens in GetLoadedDevices(RGBDeviceType).

Implements