Module cue_sdk::device

Contains the CueDevice struct, it's methods, errors, and other "device related" structs and functionality, including channels, device layout and capabilities, and more.

Structs

Channel	The iCUE platform has two main types of products. Those that are "channel-less" like mice, keyboards, etc. And those that have "channels" which are things like CPU Coolers, and what they call "DIY" devices (think LED strips you can buy and customize or combine).
ChannelDevice	Not to be confused with a CueDevice a ChannelDevice is attached to a Channel which is a "DIY" style LED channel attached to a proper CueDevice.
ChannelDeviceFromFfiError	The various errors that can happen when reading a ChannelDevice from the iCUE SDK.
CueDevice	The CueDevice holds the static device information, the device_index which much of the iCUE SDK depends on. And the CueLeds on the device which can be interacted with directly or interacted with "via" the CueDevice itself.
CueDeviceFromDeviceInfoAndIndexError	The error that can be returned when we try to create a CueDevice from existing CueDeviceInfo.
CueDeviceInfo	The static device info for the attached CueDevice, including id, model, capabilities, leds_count, and more.
DeviceCapabilities	The known capabilities of the CueDevice.
DeviceId	The immutable ID of the CueDevice.
DeviceIdFromFfiError	The error that can occur if the iCUE SDK were to give us a c_char array that couldn't be parsed as valid Utf8.
GetLedPositionsError	The error that can occur when getting led positions fails for a given CueDevice.

Enums

ChannelDeviceType	The types of devices that can be attached to a Channel.
ChannelFromFfiError	The various errors that can happen when reading a channel from the iCUE SDK.
ChannelsFromFfiError	The various errors that can happen when reading all of the channels in a given DeviceInfo from the iCUE SDK.
CueDeviceInfoFromFfiError	The various errors that can occur when reading device info from the iCUE SDK.
DeviceLayout	The layout of the given device, with keyboards having a physical_layout and logical_layout while mice only have a physical_layout.
DeviceType	The various device types supported by the iCUE SDK.
GetLedColorsError
GetLedsError	The error that can occur when getting led information fails for a given CueDevice.
GetPropertyError	The error that can be returned when we fail to get a BooleanProperty on a CueDevice.
LogicalLayout	The various logical layouts a mouse CueDevice can have.
PhysicalLayout	The various physical layouts that a keyboard CueDevice can have.

Type Definitions

DeviceCount
DeviceIndex