Class DebugDeviceProvider

Represents the abstract base implementation for a IRGBDeviceProvider.

Inheritance

object

AbstractRGBDeviceProvider

DebugDeviceProvider

Implements

IRGBDeviceProvider

IDisposable

Inherited Members

AbstractRGBDeviceProvider.IsInitialized

AbstractRGBDeviceProvider.ThrowsExceptions

AbstractRGBDeviceProvider.Devices

AbstractRGBDeviceProvider.UpdateTriggers

AbstractRGBDeviceProvider.Exception

AbstractRGBDeviceProvider.DevicesChanged

AbstractRGBDeviceProvider.Initialize(RGBDeviceType, bool)

AbstractRGBDeviceProvider.Throw(Exception, bool)

AbstractRGBDeviceProvider.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: RGB.NET.Devices.Debug

Assembly: RGB.NET.Devices.Debug.dll

Syntax

public sealed class DebugDeviceProvider : AbstractRGBDeviceProvider, IRGBDeviceProvider, IDisposable

Constructors

DebugDeviceProvider()

Initializes a new instance of the DebugDeviceProvider class.

Declaration

public DebugDeviceProvider()

Exceptions

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

Properties

Instance

Gets the singleton DebugDeviceProvider instance.

Declaration

public static DebugDeviceProvider Instance { get; }

Property Value

Type	Description
DebugDeviceProvider

Methods

AddFakeDeviceDefinition(IDeviceLayout, Action<IEnumerable<Led>>?)

Adds a new fake device definition.

Declaration

public void AddFakeDeviceDefinition(IDeviceLayout layout, Action<IEnumerable<Led>>? updateLedsAction = null)

Parameters

Type	Name	Description
IDeviceLayout	layout	The path of the layout file to be used.
Action<IEnumerable<Led>>	updateLedsAction	A action emulating led-updates.

ClearFakeDeviceDefinitions()

Removes all previously added fake device definitions.

Declaration

public void ClearFakeDeviceDefinitions()

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

AbstractRGBDeviceProvider.Dispose(bool)

InitializeSDK()

Initializes the underlying SDK.

Declaration

protected override void InitializeSDK()

Overrides

AbstractRGBDeviceProvider.InitializeSDK()

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

AbstractRGBDeviceProvider.LoadDevices()

Remarks

Filtering happens in GetLoadedDevices(RGBDeviceType).

Implements

IRGBDeviceProvider

IDisposable