Class RazerDeviceProvider

Represents the abstract base implementation for a IRGBDeviceProvider.

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

Constructors

| Edit this page View Source

RazerDeviceProvider()

Initializes a new instance of the RazerDeviceProvider class.

Declaration
public RazerDeviceProvider()
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 Razer-devices.

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

Instance

Gets the singleton RazerDeviceProvider instance.

Declaration
public static RazerDeviceProvider Instance { get; }
Property Value
Type Description
RazerDeviceProvider
| Edit this page View Source

LoadEmulatorDevices

Forces to load the devices represented by the emulator even if they aren't reported to exist.

Declaration
public bool LoadEmulatorDevices { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

PossibleX64NativePaths

Gets a modifiable list of paths used to find the native SDK-dlls for x64 applications. The first match will be used.

Declaration
public static List<string> PossibleX64NativePaths { get; }
Property Value
Type Description
List<string>
| Edit this page View Source

PossibleX86NativePaths

Gets a modifiable list of paths used to find the native SDK-dlls for x86 applications. The first match will be used.

Declaration
public static List<string> PossibleX86NativePaths { get; }
Property Value
Type Description
List<string>

Methods

| 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