C# Class CUE.NET.CueSDK

Show file Open project: DarthAffe/CUE.NET

Public Methods

Method	Description
Initialize ( bool exclusiveAccess = false ) : void	Initializes the CUE-SDK. This method should be called exactly ONE time, before anything else is done.
IsSDKAvailable ( CorsairDeviceType sdkType = null ) : bool	Checks if the SDK for the provided CorsairDeviceType is available or checks if CUE is installed and SDK supported enabled if null is provided.
Reinitialize ( ) : void	Reinitialize the CUE-SDK and temporarily hand back full control to CUE.
Reinitialize ( bool exclusiveAccess ) : void	Reinitialize the CUE-SDK and temporarily hand back full control to CUE.

Private Methods

Method	Description
CheckUpdateLoop ( ) : void	Checks if automatic updates should occur and starts/stops the update-loop if needed.
Throw ( CorsairError error ) : void
UpdateLoop ( ) : void

Method Details

Initialize() public static method

Initializes the CUE-SDK. This method should be called exactly ONE time, before anything else is done.

Thrown if the SDK is already initialized, the SDK is not compatible to CUE or if CUE returns unknown devices. Thrown if the CUE-SDK provides an error.

public static Initialize ( bool exclusiveAccess = false ) : void
exclusiveAccess	bool	Specifies whether the application should request exclusive access or not.
return	void

IsSDKAvailable() public static method

Checks if the SDK for the provided CorsairDeviceType is available or checks if CUE is installed and SDK supported enabled if null is provided.

public static IsSDKAvailable ( CorsairDeviceType sdkType = null ) : bool
sdkType	CorsairDeviceType	The to check or null to check for generall SDK availability.
return	bool

Reinitialize() public static method

Reinitialize the CUE-SDK and temporarily hand back full control to CUE.

public static Reinitialize ( ) : void
return	void

Reinitialize() public static method

Reinitialize the CUE-SDK and temporarily hand back full control to CUE.

public static Reinitialize ( bool exclusiveAccess ) : void
exclusiveAccess	bool	Specifies whether the application should request exclusive access or not.
return	void