Class PicoPiDeviceProvider
Represents the abstract base implementation for a IRGBDeviceProvider.
Inherited Members
Namespace: RGB.NET.Devices.PicoPi
Assembly: RGB.NET.Devices.PicoPi.dll
Syntax
public sealed class PicoPiDeviceProvider : AbstractRGBDeviceProvider, IRGBDeviceProvider, IDisposable
Constructors
| Edit this page View SourcePicoPiDeviceProvider()
Initializes a new instance of the PicoPiDeviceProvider class.
Declaration
public PicoPiDeviceProvider()
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 SourceDeviceDefinitions
Gets the HID-definitions for PicoPi-devices.
Declaration
public static HIDLoader<int, int> DeviceDefinitions { get; }
Property Value
Type | Description |
---|---|
HIDLoader<int, int> |
Instance
Gets the singleton PicoPiDeviceProvider instance.
Declaration
public static PicoPiDeviceProvider Instance { get; }
Property Value
Type | Description |
---|---|
PicoPiDeviceProvider |
UpdateMode
Gets or sets the endpoint used to update devices. (default Auto). If auto is set it automatically is using bulk-updates for devies with more than 40 LEDs if supported. Else HID is used.
Declaration
public UpdateMode UpdateMode { get; set; }
Property Value
Type | Description |
---|---|
UpdateMode |
Methods
| Edit this page View SourceDispose(bool)
Disposes the object and frees all resources.
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing |
|
Overrides
| Edit this page View SourceGetLoadedDevices(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().
InitializeSDK()
Initializes the underlying SDK.
Declaration
protected override void InitializeSDK()
Overrides
| Edit this page View SourceLoadDevices()
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).
Reset()
Resets the device provider and disposes all devices and update triggers.
Declaration
protected override void Reset()