Show / Hide Table of Contents

Class CorsairLegacyDeviceProvider

Represents the abstract base implementation for a IRGBDeviceProvider.

Inheritance
object
AbstractRGBDeviceProvider
CorsairLegacyDeviceProvider
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.CorsairLegacy
Assembly: RGB.NET.Devices.CorsairLegacy.dll
Syntax
public sealed class CorsairLegacyDeviceProvider : AbstractRGBDeviceProvider, IRGBDeviceProvider, IDisposable

Constructors

| Edit this page View Source

CorsairLegacyDeviceProvider()

Initializes a new instance of the CorsairLegacyDeviceProvider class.

Declaration
public CorsairLegacyDeviceProvider()
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

Instance

Gets the singleton CorsairLegacyDeviceProvider instance.

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

LastError

Gets the last error documented by CUE.

Declaration
public static CorsairError LastError { get; }
Property Value
Type Description
CorsairError
| 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>
| Edit this page View Source

ProtocolDetails

Gets the protocol details for the current SDK-connection.

Declaration
public CorsairProtocolDetails? ProtocolDetails { get; }
Property Value
Type Description
CorsairProtocolDetails

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
AbstractRGBDeviceProvider.Dispose(bool)
| Edit this page View Source

InitializeSDK()

Initializes the underlying SDK.

Declaration
protected override void InitializeSDK()
Overrides
AbstractRGBDeviceProvider.InitializeSDK()
| 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
AbstractRGBDeviceProvider.LoadDevices()
Remarks

Filtering happens in GetLoadedDevices(RGBDeviceType).

| Edit this page View Source

Reset()

Resets the device provider and disposes all devices and update triggers.

Declaration
protected override void Reset()
Overrides
AbstractRGBDeviceProvider.Reset()

Implements

IRGBDeviceProvider
IDisposable
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX