DarthAffe/CUE.NET
1
0
Fork 0
mirror of https://github.com/DarthAffe/CUE.NET.git synced 2025-12-13 09:08:34 +00:00
Code Issues Releases Wiki Activity

Added missing comment (#45)

Browse Source
This commit is contained in:
Darth Affe 2016-06-03 20:56:26 +02:00
parent c1027df0f7
commit ec9eb7aef0
1 changed files with 28 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
CueSDK.cs
View File

@ -16,10 +16,13 @@ namespace CUE.NET
{ {
#region Properties & Fields #region Properties & Fields
private static bool _isInitialized;
// ReSharper disable UnusedAutoPropertyAccessor.Global // ReSharper disable UnusedAutoPropertyAccessor.Global
/// <summary>
/// Indicates if the SDK is initialized and ready to use.
/// </summary>
public static bool IsInitialized { get; private set; }
/// <summary> /// <summary>
/// Gets the loaded architecture (x64/x86). /// Gets the loaded architecture (x64/x86).
/// </summary> /// </summary>
@ -64,11 +67,16 @@ namespace CUE.NET
#region Methods #region Methods
/// <summary>
/// Checks if the SDK for the provided <see cref="CorsairDeviceType"/> is available or checks if CUE is installed and SDK supported enabled if null is provided.
/// </summary>
/// <param name="sdkType">The <see cref="CorsairDeviceType"/> to check or null to check for generall SDK availability.</param>
/// <returns>The availability of the provided <see cref="CorsairDeviceType"/>.</returns>
public static bool IsSDKAvailable(CorsairDeviceType? sdkType = null) public static bool IsSDKAvailable(CorsairDeviceType? sdkType = null)
{ {
try try
{ {
if (_isInitialized) if (IsInitialized)
{ {
switch (sdkType) switch (sdkType)
{ {
@ -114,7 +122,7 @@ namespace CUE.NET
/// <exception cref="CUEException">Thrown if the CUE-SDK provides an error.</exception> /// <exception cref="CUEException">Thrown if the CUE-SDK provides an error.</exception>
public static void Initialize(bool exclusiveAccess = false) public static void Initialize(bool exclusiveAccess = false)
{ {
if (_isInitialized) if (IsInitialized)
throw new WrapperException("CueSDK is already initialized."); throw new WrapperException("CueSDK is already initialized.");
ProtocolDetails = new CorsairProtocolDetails(_CUESDK.CorsairPerformProtocolHandshake()); ProtocolDetails = new CorsairProtocolDetails(_CUESDK.CorsairPerformProtocolHandshake());
@ -124,7 +132,9 @@ namespace CUE.NET
Throw(error); Throw(error);
if (ProtocolDetails.BreakingChanges) if (ProtocolDetails.BreakingChanges)
throw new WrapperException("The SDK currently used isn't compatible with the installed version of CUE.\r\n" + $"CUE-Version: {ProtocolDetails.ServerVersion} (Protocol {ProtocolDetails.ServerProtocolVersion})\r\n" + $"SDK-Version: {ProtocolDetails.SdkVersion} (Protocol {ProtocolDetails.SdkProtocolVersion})"); throw new WrapperException("The SDK currently used isn't compatible with the installed version of CUE.\r\n"
+ $"CUE-Version: {ProtocolDetails.ServerVersion} (Protocol {ProtocolDetails.ServerProtocolVersion})\r\n"
+ $"SDK-Version: {ProtocolDetails.SdkVersion} (Protocol {ProtocolDetails.SdkProtocolVersion})");
if (exclusiveAccess) if (exclusiveAccess)
{ {
@ -165,7 +175,7 @@ namespace CUE.NET
Throw(error); Throw(error);
} }
_isInitialized = true; IsInitialized = true;
} }
/// <summary> /// <summary>
@ -182,7 +192,7 @@ namespace CUE.NET
/// <param name="exclusiveAccess">Specifies whether the application should request exclusive access or not.</param> /// <param name="exclusiveAccess">Specifies whether the application should request exclusive access or not.</param>
public static void Reinitialize(bool exclusiveAccess) public static void Reinitialize(bool exclusiveAccess)
{ {
if (!_isInitialized) if (!IsInitialized)
throw new WrapperException("CueSDK isn't initialized."); throw new WrapperException("CueSDK isn't initialized.");
KeyboardSDK?.ResetLeds(); KeyboardSDK?.ResetLeds();
@ -198,7 +208,9 @@ namespace CUE.NET
Throw(error); Throw(error);
if (ProtocolDetails.BreakingChanges) if (ProtocolDetails.BreakingChanges)
throw new WrapperException("The SDK currently used isn't compatible with the installed version of CUE.\r\n" + $"CUE-Version: {ProtocolDetails.ServerVersion} (Protocol {ProtocolDetails.ServerProtocolVersion})\r\n" + $"SDK-Version: {ProtocolDetails.SdkVersion} (Protocol {ProtocolDetails.SdkProtocolVersion})"); throw new WrapperException("The SDK currently used isn't compatible with the installed version of CUE.\r\n"
+ $"CUE-Version: {ProtocolDetails.ServerVersion} (Protocol {ProtocolDetails.ServerProtocolVersion})\r\n"
+ $"SDK-Version: {ProtocolDetails.SdkVersion} (Protocol {ProtocolDetails.SdkProtocolVersion})");
if (exclusiveAccess) if (exclusiveAccess)
if (!_CUESDK.CorsairRequestControl(CorsairAccessMode.ExclusiveLightingControl)) if (!_CUESDK.CorsairRequestControl(CorsairAccessMode.ExclusiveLightingControl))
@ -221,16 +233,19 @@ namespace CUE.NET
} }
if (KeyboardSDK != null) if (KeyboardSDK != null)
if (!reloadedDevices.ContainsKey(CorsairDeviceType.Keyboard) || KeyboardSDK.KeyboardDeviceInfo.Model != reloadedDevices[CorsairDeviceType.Keyboard].Model) if (!reloadedDevices.ContainsKey(CorsairDeviceType.Keyboard)
|| KeyboardSDK.KeyboardDeviceInfo.Model != reloadedDevices[CorsairDeviceType.Keyboard].Model)
throw new WrapperException("The previously loaded Keyboard got disconnected."); throw new WrapperException("The previously loaded Keyboard got disconnected.");
if (MouseSDK != null) if (MouseSDK != null)
if (!reloadedDevices.ContainsKey(CorsairDeviceType.Mouse) || MouseSDK.MouseDeviceInfo.Model != reloadedDevices[CorsairDeviceType.Mouse].Model) if (!reloadedDevices.ContainsKey(CorsairDeviceType.Mouse)
|| MouseSDK.MouseDeviceInfo.Model != reloadedDevices[CorsairDeviceType.Mouse].Model)
throw new WrapperException("The previously loaded Mouse got disconnected."); throw new WrapperException("The previously loaded Mouse got disconnected.");
if (HeadsetSDK != null) if (HeadsetSDK != null)
if (!reloadedDevices.ContainsKey(CorsairDeviceType.Headset) || HeadsetSDK.HeadsetDeviceInfo.Model != reloadedDevices[CorsairDeviceType.Headset].Model) if (!reloadedDevices.ContainsKey(CorsairDeviceType.Headset)
|| HeadsetSDK.HeadsetDeviceInfo.Model != reloadedDevices[CorsairDeviceType.Headset].Model)
throw new WrapperException("The previously loaded Headset got disconnected."); throw new WrapperException("The previously loaded Headset got disconnected.");
_isInitialized = true; IsInitialized = true;
} }
private static void Throw(CorsairError error) private static void Throw(CorsairError error)
@ -240,7 +255,7 @@ namespace CUE.NET
KeyboardSDK = null; KeyboardSDK = null;
MouseSDK = null; MouseSDK = null;
HeadsetSDK = null; HeadsetSDK = null;
_isInitialized = false; IsInitialized = false;
throw new CUEException(error); throw new CUEException(error);
} }